|
|
|
|
@@ -5,22 +5,22 @@ DO NOT EDIT !
|
|
|
|
|
-->
|
|
|
|
|
The `google-clouduseraccountsvm_beta` library allows access to all features of the *Google Cloud User Accounts* service.
|
|
|
|
|
|
|
|
|
|
This documentation was generated from *Cloud User Accounts* crate version *1.0.10+20160316*, where *20160316* is the exact revision of the *clouduseraccounts:vm_beta* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.10*.
|
|
|
|
|
This documentation was generated from *Cloud User Accounts* crate version *1.0.11+20160316*, where *20160316* is the exact revision of the *clouduseraccounts:vm_beta* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.11*.
|
|
|
|
|
|
|
|
|
|
Everything else about the *Cloud User Accounts* *vm_beta* API can be found at the
|
|
|
|
|
[official documentation site](https://cloud.google.com/compute/docs/access/user-accounts/api/latest/).
|
|
|
|
|
# Features
|
|
|
|
|
|
|
|
|
|
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.CloudUserAccounts.html) ...
|
|
|
|
|
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.CloudUserAccounts.html) ...
|
|
|
|
|
|
|
|
|
|
* global accounts operations
|
|
|
|
|
* [*delete*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GlobalAccountsOperationDeleteCall.html), [*get*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GlobalAccountsOperationGetCall.html) and [*list*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GlobalAccountsOperationListCall.html)
|
|
|
|
|
* [groups](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.Group.html)
|
|
|
|
|
* [*add member*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GroupAddMemberCall.html), [*delete*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GroupDeleteCall.html), [*get*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GroupGetCall.html), [*insert*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GroupInsertCall.html), [*list*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GroupListCall.html) and [*remove member*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.GroupRemoveMemberCall.html)
|
|
|
|
|
* [*delete*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GlobalAccountsOperationDeleteCall.html), [*get*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GlobalAccountsOperationGetCall.html) and [*list*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GlobalAccountsOperationListCall.html)
|
|
|
|
|
* [groups](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.Group.html)
|
|
|
|
|
* [*add member*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GroupAddMemberCall.html), [*delete*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GroupDeleteCall.html), [*get*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GroupGetCall.html), [*insert*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GroupInsertCall.html), [*list*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GroupListCall.html) and [*remove member*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.GroupRemoveMemberCall.html)
|
|
|
|
|
* linux
|
|
|
|
|
* [*get authorized keys view*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.LinuxGetAuthorizedKeysViewCall.html) and [*get linux account views*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.LinuxGetLinuxAccountViewCall.html)
|
|
|
|
|
* [users](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.User.html)
|
|
|
|
|
* [*add public key*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.UserAddPublicKeyCall.html), [*delete*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.UserDeleteCall.html), [*get*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.UserGetCall.html), [*insert*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.UserInsertCall.html), [*list*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.UserListCall.html) and [*remove public key*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.UserRemovePublicKeyCall.html)
|
|
|
|
|
* [*get authorized keys view*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.LinuxGetAuthorizedKeysViewCall.html) and [*get linux account views*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.LinuxGetLinuxAccountViewCall.html)
|
|
|
|
|
* [users](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.User.html)
|
|
|
|
|
* [*add public key*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.UserAddPublicKeyCall.html), [*delete*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.UserDeleteCall.html), [*get*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.UserGetCall.html), [*insert*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.UserInsertCall.html), [*list*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.UserListCall.html) and [*remove public key*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.UserRemovePublicKeyCall.html)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -29,17 +29,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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/struct.CloudUserAccounts.html)**
|
|
|
|
|
* **[Hub](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/struct.CloudUserAccounts.html)**
|
|
|
|
|
* a central object to maintain state and allow accessing all *Activities*
|
|
|
|
|
* creates [*Method Builders*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.MethodsBuilder.html) which in turn
|
|
|
|
|
allow access to individual [*Call Builders*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.CallBuilder.html)
|
|
|
|
|
* **[Resources](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.Resource.html)**
|
|
|
|
|
* creates [*Method Builders*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/trait.MethodsBuilder.html) which in turn
|
|
|
|
|
allow access to individual [*Call Builders*](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/trait.CallBuilder.html)
|
|
|
|
|
* **[Resources](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/trait.Resource.html)**
|
|
|
|
|
* primary types that you can apply *Activities* to
|
|
|
|
|
* a collection of properties and *Parts*
|
|
|
|
|
* **[Parts](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.Part.html)**
|
|
|
|
|
* **[Parts](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/trait.Part.html)**
|
|
|
|
|
* a collection of properties
|
|
|
|
|
* never directly used in *Activities*
|
|
|
|
|
* **[Activities](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.CallBuilder.html)**
|
|
|
|
|
* **[Activities](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/trait.CallBuilder.html)**
|
|
|
|
|
* operations to apply to *Resources*
|
|
|
|
|
|
|
|
|
|
All *structures* are marked with applicable traits to further categorize them and ease browsing.
|
|
|
|
|
@@ -144,17 +144,17 @@ match result {
|
|
|
|
|
```
|
|
|
|
|
## Handling Errors
|
|
|
|
|
|
|
|
|
|
All errors produced by the system are provided either as [Result](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/enum.Result.html) enumeration as return value of
|
|
|
|
|
All errors produced by the system are provided either as [Result](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
|
|
|
|
|
[Hub Delegate](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/enum.Result.html), should be
|
|
|
|
|
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.ResponseResult.html), it will return that by default.
|
|
|
|
|
If such a method also supports a [Response Result](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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")`.
|
|
|
|
|
|
|
|
|
|
@@ -164,29 +164,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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.Delegate.html) to the
|
|
|
|
|
[Method Builder](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/trait.Delegate.html) to the
|
|
|
|
|
[Method Builder](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
|
|
|
|
|
The [delegate trait](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.RequestValue.html) and
|
|
|
|
|
[decodable](https://docs.rs/google-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/trait.RequestValue.html) and
|
|
|
|
|
[decodable](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.Part.html) which are identifiable by name, which will be sent to
|
|
|
|
|
Most optionals are are considered [Parts](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
|
|
|
|
|
Using [method builders](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/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-clouduseraccountsvm_beta/1.0.10+20160316/google_clouduseraccountsvm_beta/trait.RequestValue.html) are moved
|
|
|
|
|
* [request values](https://docs.rs/google-clouduseraccountsvm_beta/1.0.11+20160316/google_clouduseraccountsvm_beta/trait.RequestValue.html) are moved
|
|
|
|
|
|
|
|
|
|
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
|
|
|
|
|
|
|
|
|
|
|