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

prepare release of version 2.0, regen all APIs

Browse Source
This commit is contained in:
Sebastian Thiel
2021-04-01 23:46:26 +08:00
parent f1c05f2554
commit c606d37dd3
3415 changed files with 3620084 additions and 2930380 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
gen/binaryauthorization1_beta1/README.md
View File

@@ -5,16 +5,18 @@ DO NOT EDIT !
-->
The `google-binaryauthorization1_beta1` library allows access to all features of the *Google Binary Authorization* service.
This documentation was generated from *Binary Authorization* crate version *1.0.14+20200619*, where *20200619* is the exact revision of the *binaryauthorization:v1beta1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.14*.
This documentation was generated from *Binary Authorization* crate version *2.0.0+20210318*, where *20210318* is the exact revision of the *binaryauthorization:v1beta1* schema built by the [mako](http://www.makotemplates.org/) code generator *v2.0.0*.
Everything else about the *Binary Authorization* *v1_beta1* API can be found at the
[official documentation site](https://cloud.google.com/binary-authorization/).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.BinaryAuthorization.html) ...
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/BinaryAuthorization) ...
* projects
* [*attestors create*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectAttestorCreateCall.html), [*attestors delete*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectAttestorDeleteCall.html), [*attestors get*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectAttestorGetCall.html), [*attestors get iam policy*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectAttestorGetIamPolicyCall.html), [*attestors list*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectAttestorListCall.html), [*attestors set iam policy*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectAttestorSetIamPolicyCall.html), [*attestors test iam permissions*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectAttestorTestIamPermissionCall.html), [*attestors update*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectAttestorUpdateCall.html), [*get policy*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectGetPolicyCall.html), [*policy get iam policy*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectPolicyGetIamPolicyCall.html), [*policy set iam policy*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectPolicySetIamPolicyCall.html), [*policy test iam permissions*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectPolicyTestIamPermissionCall.html) and [*update policy*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.ProjectUpdatePolicyCall.html)
* [*attestors create*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorCreateCall), [*attestors delete*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorDeleteCall), [*attestors get*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorGetCall), [*attestors get iam policy*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorGetIamPolicyCall), [*attestors list*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorListCall), [*attestors set iam policy*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorSetIamPolicyCall), [*attestors test iam permissions*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorTestIamPermissionCall), [*attestors update*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorUpdateCall), [*attestors validate attestation occurrence*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectAttestorValidateAttestationOccurrenceCall), [*get policy*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectGetPolicyCall), [*policy get iam policy*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectPolicyGetIamPolicyCall), [*policy set iam policy*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectPolicySetIamPolicyCall), [*policy test iam permissions*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectPolicyTestIamPermissionCall) and [*update policy*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::ProjectUpdatePolicyCall)
* systempolicy
* [*get policy*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/api::SystempolicyGetPolicyCall)
@@ -23,17 +25,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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/struct.BinaryAuthorization.html)**
* **[Hub](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/BinaryAuthorization)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.CallBuilder.html)
* **[Resources](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.Resource.html)**
* creates [*Method Builders*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::CallBuilder)
* **[Resources](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.Part.html)**
* **[Parts](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.CallBuilder.html)**
* **[Activities](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::CallBuilder)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -41,16 +43,16 @@ All *structures* are marked with applicable traits to further categorize them an
Generally speaking, you can invoke *Activities* like this:
```Rust,ignore
let r = hub.resource().activity(...).doit()
let r = hub.resource().activity(...).doit().await
```
Or specifically ...
```ignore
let r = hub.projects().policy_set_iam_policy(...).doit()
let r = hub.projects().attestors_set_iam_policy(...).doit()
let r = hub.projects().policy_get_iam_policy(...).doit()
let r = hub.projects().attestors_get_iam_policy(...).doit()
let r = hub.projects().attestors_get_iam_policy(...).doit().await
let r = hub.projects().attestors_set_iam_policy(...).doit().await
let r = hub.projects().policy_get_iam_policy(...).doit().await
let r = hub.projects().policy_set_iam_policy(...).doit().await
```
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
@@ -70,11 +72,11 @@ google-binaryauthorization1_beta1 = "*"
# 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"
hyper = "^0.14"
hyper-rustls = "^0.22"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"
yup-oauth2 = "^5.0"
```
## A complete example
@@ -84,40 +86,37 @@ extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_binaryauthorization1_beta1 as binaryauthorization1_beta1;
use binaryauthorization1_beta1::SetIamPolicyRequest;
use binaryauthorization1_beta1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use oauth2;
use binaryauthorization1_beta1::BinaryAuthorization;
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: ApplicationSecret = Default::default();
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you,
// unless you replace `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
<MemoryStorage as Default>::default(), None);
let mut hub = BinaryAuthorization::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = SetIamPolicyRequest::default();
let auth = yup_oauth2::InstalledFlowAuthenticator::builder(
secret,
yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = BinaryAuthorization::new(hyper::Client::builder().build(hyper_rustls::HttpsConnector::with_native_roots()), auth);
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().policy_set_iam_policy(req, "resource")
.doit();
let result = hub.projects().attestors_get_iam_policy("resource")
.options_requested_policy_version(-33)
.doit().await;
match result {
Err(e) => match e {
// The Error enum provides details about what exactly happened.
// You can also just use its `Debug`, `Display` or `Error` traits
Error::HttpError(_)
|Error::Io(_)
|Error::MissingAPIKey
|Error::MissingToken(_)
|Error::Cancelled
@@ -133,17 +132,17 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/enum.Result.html) enumeration as return value of
All errors produced by the system are provided either as [Result](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
[Hub Delegate](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/enum.Result.html), should be
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.ResponseResult.html), it will return that by default.
If such a method also supports a [Response Result](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/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")`.
@@ -153,29 +152,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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.Delegate.html) to the
[Method Builder](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/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-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::Delegate) to the
[Method Builder](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.RequestValue.html) and
[decodable](https://docs.rs/google-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/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 [encodable](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::RequestValue) and
[decodable](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.Part.html) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
Using [method builders](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/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-binaryauthorization1_beta1/1.0.14+20200619/google_binaryauthorization1_beta1/trait.RequestValue.html) are moved
* [request values](https://docs.rs/google-binaryauthorization1_beta1/2.0.0+20210318/google_binaryauthorization1_beta1/client::RequestValue) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.