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

make regen-apis

Browse Source
This commit is contained in:
OMGeeky
2024-05-16 21:23:40 +02:00
parent 92ad312680
commit ba42c83516
5108 changed files with 1615625 additions and 992044 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
gen/cloudsupport2_beta/README.md
View File

@@ -5,29 +5,29 @@ DO NOT EDIT !
-->
The `google-cloudsupport2_beta` library allows access to all features of the *Google Cloud Support* service.
This documentation was generated from *Cloud Support* crate version *5.0.4+20240304*, where *20240304* is the exact revision of the *cloudsupport:v2beta* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.4*.
This documentation was generated from *Cloud Support* crate version *5.0.5+20240416*, where *20240416* is the exact revision of the *cloudsupport:v2beta* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.5*.
Everything else about the *Cloud Support* *v2_beta* API can be found at the
[official documentation site](https://cloud.google.com/support/docs/apis).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/CloudSupport) ...
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/CloudSupport) ...
* [case classifications](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseClassification)
* [*search*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseClassificationSearchCall)
* [cases](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::Case)
* [*attachments list*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseAttachmentListCall), [*close*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseCloseCall), [*comments create*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseCommentCreateCall), [*comments list*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseCommentListCall), [*create*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseCreateCall), [*escalate*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseEscalateCall), [*get*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseGetCall), [*list*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseListCall), [*patch*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CasePatchCall) and [*search*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::CaseSearchCall)
* [media](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::Media)
* [*download*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::MediaDownloadCall) and [*upload*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::MediaUploadCall)
* [case classifications](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseClassification)
* [*search*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseClassificationSearchCall)
* [cases](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::Case)
* [*attachments list*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseAttachmentListCall), [*close*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseCloseCall), [*comments create*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseCommentCreateCall), [*comments list*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseCommentListCall), [*create*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseCreateCall), [*escalate*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseEscalateCall), [*get*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseGetCall), [*list*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseListCall), [*patch*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CasePatchCall) and [*search*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::CaseSearchCall)
* [media](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::Media)
* [*download*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::MediaDownloadCall) and [*upload*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::MediaUploadCall)
Upload supported by ...
* [*upload media*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::MediaUploadCall)
* [*upload media*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::MediaUploadCall)
Download supported by ...
* [*download media*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/api::MediaDownloadCall)
* [*download media*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/api::MediaDownloadCall)
@@ -35,17 +35,17 @@ Download supported by ...
The API is structured into the following primary items:
* **[Hub](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/CloudSupport)**
* **[Hub](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/CloudSupport)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::CallBuilder)
* **[Resources](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::Resource)**
* creates [*Method Builders*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::CallBuilder)
* **[Resources](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::Part)**
* **[Parts](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::CallBuilder)**
* **[Activities](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::CallBuilder)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -71,8 +71,8 @@ let r = hub.cases().patch(...).doit().await
let r = hub.cases().search(...).doit().await
```
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired.
The `doit()` method performs the actual communication with the server and returns the respective result.
@@ -96,30 +96,30 @@ extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudsupport2_beta as cloudsupport2_beta;
use cloudsupport2_beta::{Result, Error};
use cloudsupport2_beta::api::enums::*;
use std::default::Default;
use cloudsupport2_beta::{CloudSupport, oauth2, hyper, hyper_rustls, chrono, FieldMask};
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you,
// 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
// 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 = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = CloudSupport::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
let mut hub = CloudSupport::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), 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.cases().list("parent")
.product_line("magna")
.page_token("no")
.page_size(-55)
.filter("voluptua.")
.page_token("magna")
.page_size(-11)
.filter("ipsum")
.doit().await;
match result {
@@ -143,49 +143,49 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/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-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
All errors produced by the system are provided either as [Result](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/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-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/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
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-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::Result), should be
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::ResponseResult), it will return that by default.
If such a method also supports a [Response Result](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/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")`.
Methods supporting uploads can do so using up to 2 different protocols:
*simple* and *resumable*. The distinctiveness of each is represented by customized
Methods supporting uploads can do so using up to 2 different protocols:
*simple* and *resumable*. The distinctiveness of each is represented by customized
`doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively.
## Customization and Callbacks
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::Delegate) to the
[Method Builder](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/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
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::Delegate) to the
[Method Builder](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/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-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/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-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::RequestValue) and
[decodable](https://docs.rs/google-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/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-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::RequestValue) and
[decodable](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/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-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::Part) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/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-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
Using [method builders](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/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-cloudsupport2_beta/5.0.4+20240304/google_cloudsupport2_beta/client::RequestValue) are moved
* [request values](https://docs.rs/google-cloudsupport2_beta/5.0.5+20240416/google_cloudsupport2_beta/client::RequestValue) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
@@ -194,7 +194,7 @@ Arguments will always be copied or cloned into the builder, to make them indepen
[google-go-api]: https://github.com/google/google-api-go-client
# License
The **cloudsupport2_beta** library was generated by Sebastian Thiel, and is placed
The **cloudsupport2_beta** library was generated by Sebastian Thiel, and is placed
under the *MIT* license.
You can read the full text at the repository's [license file][repo-license].