|
|
|
|
@@ -5,24 +5,24 @@ DO NOT EDIT !
|
|
|
|
|
-->
|
|
|
|
|
The `google-iap1` library allows access to all features of the *Google Cloud IAP* service.
|
|
|
|
|
|
|
|
|
|
This documentation was generated from *Cloud IAP* crate version *2.0.3+20210326*, where *20210326* is the exact revision of the *iap:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v2.0.3*.
|
|
|
|
|
This documentation was generated from *Cloud IAP* crate version *2.0.4+20210326*, where *20210326* is the exact revision of the *iap:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v2.0.4*.
|
|
|
|
|
|
|
|
|
|
Everything else about the *Cloud IAP* *v1* API can be found at the
|
|
|
|
|
[official documentation site](https://cloud.google.com/iap).
|
|
|
|
|
# Features
|
|
|
|
|
|
|
|
|
|
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/CloudIAP) ...
|
|
|
|
|
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/CloudIAP) ...
|
|
|
|
|
|
|
|
|
|
* projects
|
|
|
|
|
* [*brands create*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::ProjectBrandCreateCall), [*brands get*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::ProjectBrandGetCall), [*brands identity aware proxy clients create*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientCreateCall), [*brands identity aware proxy clients delete*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientDeleteCall), [*brands identity aware proxy clients get*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientGetCall), [*brands identity aware proxy clients list*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientListCall), [*brands identity aware proxy clients reset secret*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientResetSecretCall) and [*brands list*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::ProjectBrandListCall)
|
|
|
|
|
* [*brands create*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::ProjectBrandCreateCall), [*brands get*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::ProjectBrandGetCall), [*brands identity aware proxy clients create*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientCreateCall), [*brands identity aware proxy clients delete*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientDeleteCall), [*brands identity aware proxy clients get*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientGetCall), [*brands identity aware proxy clients list*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientListCall), [*brands identity aware proxy clients reset secret*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::ProjectBrandIdentityAwareProxyClientResetSecretCall) and [*brands list*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::ProjectBrandListCall)
|
|
|
|
|
|
|
|
|
|
Other activities are ...
|
|
|
|
|
|
|
|
|
|
* [get iam policy](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::MethodGetIamPolicyCall)
|
|
|
|
|
* [get iap settings](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::MethodGetIapSettingCall)
|
|
|
|
|
* [set iam policy](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::MethodSetIamPolicyCall)
|
|
|
|
|
* [test iam permissions](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::MethodTestIamPermissionCall)
|
|
|
|
|
* [update iap settings](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/api::MethodUpdateIapSettingCall)
|
|
|
|
|
* [get iam policy](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::MethodGetIamPolicyCall)
|
|
|
|
|
* [get iap settings](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::MethodGetIapSettingCall)
|
|
|
|
|
* [set iam policy](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::MethodSetIamPolicyCall)
|
|
|
|
|
* [test iam permissions](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::MethodTestIamPermissionCall)
|
|
|
|
|
* [update iap settings](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/api::MethodUpdateIapSettingCall)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -30,17 +30,17 @@ Other activities are ...
|
|
|
|
|
|
|
|
|
|
The API is structured into the following primary items:
|
|
|
|
|
|
|
|
|
|
* **[Hub](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/CloudIAP)**
|
|
|
|
|
* **[Hub](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/CloudIAP)**
|
|
|
|
|
* a central object to maintain state and allow accessing all *Activities*
|
|
|
|
|
* creates [*Method Builders*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::MethodsBuilder) which in turn
|
|
|
|
|
allow access to individual [*Call Builders*](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::CallBuilder)
|
|
|
|
|
* **[Resources](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::Resource)**
|
|
|
|
|
* creates [*Method Builders*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::MethodsBuilder) which in turn
|
|
|
|
|
allow access to individual [*Call Builders*](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::CallBuilder)
|
|
|
|
|
* **[Resources](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::Resource)**
|
|
|
|
|
* primary types that you can apply *Activities* to
|
|
|
|
|
* a collection of properties and *Parts*
|
|
|
|
|
* **[Parts](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::Part)**
|
|
|
|
|
* **[Parts](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::Part)**
|
|
|
|
|
* a collection of properties
|
|
|
|
|
* never directly used in *Activities*
|
|
|
|
|
* **[Activities](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::CallBuilder)**
|
|
|
|
|
* **[Activities](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::CallBuilder)**
|
|
|
|
|
* operations to apply to *Resources*
|
|
|
|
|
|
|
|
|
|
All *structures* are marked with applicable traits to further categorize them and ease browsing.
|
|
|
|
|
@@ -141,17 +141,17 @@ match result {
|
|
|
|
|
```
|
|
|
|
|
## Handling Errors
|
|
|
|
|
|
|
|
|
|
All errors produced by the system are provided either as [Result](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::Result) enumeration as return value of
|
|
|
|
|
All errors produced by the system are provided either as [Result](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::Result) enumeration as return value of
|
|
|
|
|
the doit() methods, or handed as possibly intermediate results to either the
|
|
|
|
|
[Hub Delegate](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
|
|
|
|
|
[Hub Delegate](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::Delegate), 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-iap1/2.0.3+20210326/google_iap1/client::Result), should be
|
|
|
|
|
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::Result), should be
|
|
|
|
|
read by you to obtain the media.
|
|
|
|
|
If such a method also supports a [Response Result](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::ResponseResult), it will return that by default.
|
|
|
|
|
If such a method also supports a [Response Result](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::ResponseResult), 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")`.
|
|
|
|
|
|
|
|
|
|
@@ -161,29 +161,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-iap1/2.0.3+20210326/google_iap1/client::Delegate) to the
|
|
|
|
|
[Method Builder](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::CallBuilder) before making the final `doit()` call.
|
|
|
|
|
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::Delegate) to the
|
|
|
|
|
[Method Builder](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::CallBuilder) 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-iap1/2.0.3+20210326/google_iap1/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
|
|
|
|
|
The [delegate trait](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::Delegate) 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 [encodable](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::RequestValue) and
|
|
|
|
|
[decodable](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
|
|
|
|
|
All structures provided by this library are made to be [encodable](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::RequestValue) and
|
|
|
|
|
[decodable](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
|
|
|
|
|
are valid.
|
|
|
|
|
Most optionals are are considered [Parts](https://docs.rs/google-iap1/2.0.3+20210326/google_iap1/client::Part) which are identifiable by name, which will be sent to
|
|
|
|
|
Most optionals are are considered [Parts](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::Part) 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-iap1/2.0.3+20210326/google_iap1/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
|
|
|
|
|
Using [method builders](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::CallBuilder), 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-iap1/2.0.3+20210326/google_iap1/client::RequestValue) are moved
|
|
|
|
|
* [request values](https://docs.rs/google-iap1/2.0.4+20210326/google_iap1/client::RequestValue) are moved
|
|
|
|
|
|
|
|
|
|
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
|
|
|
|
|
|
|
|
|
|
|