OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update to latest versions of API declarations

Browse Source
This commit is contained in:
Sebastian Thiel
2018-10-13 13:49:14 +02:00
parent 5a67475b54
commit 255c7f5ad5
1508 changed files with 819225 additions and 838421 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
gen/ml1/README.md
View File

@@ -5,16 +5,16 @@ DO NOT EDIT !
-->
The `google-ml1` library allows access to all features of the *Google Cloud Machine Learning Engine* service.
This documentation was generated from *Cloud Machine Learning Engine* crate version *1.0.7+20171208*, where *20171208* is the exact revision of the *ml:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.7*.
This documentation was generated from *Cloud Machine Learning Engine* crate version *1.0.7+20181009*, where *20181009* is the exact revision of the *ml:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.7*.
Everything else about the *Cloud Machine Learning Engine* *v1* API can be found at the
[official documentation site](https://cloud.google.com/ml/).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.CloudMachineLearningEngine.html) ...
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.CloudMachineLearningEngine.html) ...
* projects
* [*get config*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectGetConfigCall.html), [*jobs cancel*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectJobCancelCall.html), [*jobs create*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectJobCreateCall.html), [*jobs get*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectJobGetCall.html), [*jobs get iam policy*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectJobGetIamPolicyCall.html), [*jobs list*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectJobListCall.html), [*jobs patch*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectJobPatchCall.html), [*jobs set iam policy*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectJobSetIamPolicyCall.html), [*jobs test iam permissions*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectJobTestIamPermissionCall.html), [*locations get*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectLocationGetCall.html), [*locations list*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectLocationListCall.html), [*models create*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelCreateCall.html), [*models delete*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelDeleteCall.html), [*models get*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelGetCall.html), [*models get iam policy*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelGetIamPolicyCall.html), [*models list*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelListCall.html), [*models patch*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelPatchCall.html), [*models set iam policy*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelSetIamPolicyCall.html), [*models test iam permissions*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelTestIamPermissionCall.html), [*models versions create*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelVersionCreateCall.html), [*models versions delete*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelVersionDeleteCall.html), [*models versions get*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelVersionGetCall.html), [*models versions list*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelVersionListCall.html), [*models versions patch*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelVersionPatchCall.html), [*models versions set default*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectModelVersionSetDefaultCall.html), [*operations cancel*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectOperationCancelCall.html), [*operations delete*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectOperationDeleteCall.html), [*operations get*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectOperationGetCall.html), [*operations list*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectOperationListCall.html) and [*predict*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.ProjectPredictCall.html)
* [*get config*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectGetConfigCall.html), [*jobs cancel*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectJobCancelCall.html), [*jobs create*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectJobCreateCall.html), [*jobs get*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectJobGetCall.html), [*jobs get iam policy*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectJobGetIamPolicyCall.html), [*jobs list*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectJobListCall.html), [*jobs patch*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectJobPatchCall.html), [*jobs set iam policy*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectJobSetIamPolicyCall.html), [*jobs test iam permissions*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectJobTestIamPermissionCall.html), [*locations get*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectLocationGetCall.html), [*locations list*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectLocationListCall.html), [*models create*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelCreateCall.html), [*models delete*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelDeleteCall.html), [*models get*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelGetCall.html), [*models get iam policy*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelGetIamPolicyCall.html), [*models list*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelListCall.html), [*models patch*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelPatchCall.html), [*models set iam policy*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelSetIamPolicyCall.html), [*models test iam permissions*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelTestIamPermissionCall.html), [*models versions create*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelVersionCreateCall.html), [*models versions delete*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelVersionDeleteCall.html), [*models versions get*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelVersionGetCall.html), [*models versions list*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelVersionListCall.html), [*models versions patch*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelVersionPatchCall.html), [*models versions set default*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectModelVersionSetDefaultCall.html), [*operations cancel*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectOperationCancelCall.html), [*operations delete*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectOperationDeleteCall.html), [*operations get*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectOperationGetCall.html), [*operations list*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectOperationListCall.html) and [*predict*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.ProjectPredictCall.html)
@@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](https://docs.r
The API is structured into the following primary items:
* **[Hub](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/struct.CloudMachineLearningEngine.html)**
* **[Hub](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/struct.CloudMachineLearningEngine.html)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.CallBuilder.html)
* **[Resources](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.Resource.html)**
* creates [*Method Builders*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.CallBuilder.html)
* **[Resources](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.Resource.html)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.Part.html)**
* **[Parts](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.Part.html)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.CallBuilder.html)**
* **[Activities](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.CallBuilder.html)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -69,6 +69,14 @@ To use this library, you would put the following lines into your `Cargo.toml` fi
```toml
[dependencies]
google-ml1 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"
```
## A complete example
@@ -128,17 +136,17 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/enum.Result.html) enumeration as return value of
All errors produced by the system are provided either as [Result](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/enum.Result.html) enumeration as return value of
the doit() methods, or handed as possibly intermediate results to either the
[Hub Delegate](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
[Hub Delegate](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
makes the system potentially resilient to all kinds of errors.
## Uploads and Downloads
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/enum.Result.html), should be
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/enum.Result.html), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.ResponseResult.html), it will return that by default.
If such a method also supports a [Response Result](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.ResponseResult.html), it will return that by default.
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
this call: `.param("alt", "media")`.
@@ -148,29 +156,29 @@ Methods supporting uploads can do so using up to 2 different protocols:
## Customization and Callbacks
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.Delegate.html) to the
[Method Builder](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.CallBuilder.html) before making the final `doit()` call.
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.Delegate.html) to the
[Method Builder](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.CallBuilder.html) before making the final `doit()` call.
Respective methods will be called to provide progress information, as well as determine whether the system should
retry on failure.
The [delegate trait](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
## Optional Parts in Server-Requests
All structures provided by this library are made to be [enocodable](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.RequestValue.html) and
[decodable](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses
All structures provided by this library are made to be [enocodable](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.RequestValue.html) and
[decodable](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses
are valid.
Most optionals are are considered [Parts](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.Part.html) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.Part.html) which are identifiable by name, which will be sent to
the server to indicate either the set parts of the request or the desired parts in the response.
## Builder Arguments
Using [method builders](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
Using [method builders](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
These will always take a single argument, for which the following statements are true.
* [PODs][wiki-pod] are handed by copy
* strings are passed as `&str`
* [request values](https://docs.rs/google-ml1/1.0.7+20171208/google_ml1/trait.RequestValue.html) are moved
* [request values](https://docs.rs/google-ml1/1.0.7+20181009/google_ml1/trait.RequestValue.html) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.