mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
Upgrade to latest API versions + code regen
This commit is contained in:
@@ -5,16 +5,16 @@ DO NOT EDIT !
|
||||
-->
|
||||
The `google-cloudtasks2_beta2` library allows access to all features of the *Google Cloud Tasks* service.
|
||||
|
||||
This documentation was generated from *Cloud Tasks* crate version *1.0.6+20170926*, where *20170926* is the exact revision of the *cloudtasks:v2beta2* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.6*.
|
||||
This documentation was generated from *Cloud Tasks* crate version *1.0.6+20171208*, where *20171208* is the exact revision of the *cloudtasks:v2beta2* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.6*.
|
||||
|
||||
Everything else about the *Cloud Tasks* *v2_beta2* API can be found at the
|
||||
[official documentation site](https://cloud.google.com/cloud-tasks/).
|
||||
# Features
|
||||
|
||||
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.CloudTasks.html) ...
|
||||
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.CloudTasks.html) ...
|
||||
|
||||
* projects
|
||||
* [*locations get*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationGetCall.html), [*locations list*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationListCall.html), [*locations queues create*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueCreateCall.html), [*locations queues delete*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueDeleteCall.html), [*locations queues get*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueGetCall.html), [*locations queues get iam policy*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueGetIamPolicyCall.html), [*locations queues list*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueListCall.html), [*locations queues patch*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueuePatchCall.html), [*locations queues pause*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueuePauseCall.html), [*locations queues purge*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueuePurgeCall.html), [*locations queues resume*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueResumeCall.html), [*locations queues set iam policy*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueSetIamPolicyCall.html), [*locations queues tasks acknowledge*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskAcknowledgeCall.html), [*locations queues tasks cancel lease*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskCancelLeaseCall.html), [*locations queues tasks create*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskCreateCall.html), [*locations queues tasks delete*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskDeleteCall.html), [*locations queues tasks get*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskGetCall.html), [*locations queues tasks list*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskListCall.html), [*locations queues tasks pull*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskPullCall.html), [*locations queues tasks renew lease*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskRenewLeaseCall.html), [*locations queues tasks run*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskRunCall.html) and [*locations queues test iam permissions*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.ProjectLocationQueueTestIamPermissionCall.html)
|
||||
* [*locations get*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationGetCall.html), [*locations list*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationListCall.html), [*locations queues create*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueCreateCall.html), [*locations queues delete*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueDeleteCall.html), [*locations queues get*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueGetCall.html), [*locations queues get iam policy*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueGetIamPolicyCall.html), [*locations queues list*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueListCall.html), [*locations queues patch*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueuePatchCall.html), [*locations queues pause*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueuePauseCall.html), [*locations queues purge*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueuePurgeCall.html), [*locations queues resume*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueResumeCall.html), [*locations queues set iam policy*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueSetIamPolicyCall.html), [*locations queues tasks acknowledge*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskAcknowledgeCall.html), [*locations queues tasks cancel lease*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskCancelLeaseCall.html), [*locations queues tasks create*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskCreateCall.html), [*locations queues tasks delete*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskDeleteCall.html), [*locations queues tasks get*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskGetCall.html), [*locations queues tasks list*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskListCall.html), [*locations queues tasks pull*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskPullCall.html), [*locations queues tasks renew lease*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskRenewLeaseCall.html), [*locations queues tasks run*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTaskRunCall.html) and [*locations queues test iam permissions*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.ProjectLocationQueueTestIamPermissionCall.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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/struct.CloudTasks.html)**
|
||||
* **[Hub](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/struct.CloudTasks.html)**
|
||||
* a central object to maintain state and allow accessing all *Activities*
|
||||
* creates [*Method Builders*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.MethodsBuilder.html) which in turn
|
||||
allow access to individual [*Call Builders*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.CallBuilder.html)
|
||||
* **[Resources](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.Resource.html)**
|
||||
* creates [*Method Builders*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/trait.MethodsBuilder.html) which in turn
|
||||
allow access to individual [*Call Builders*](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/trait.CallBuilder.html)
|
||||
* **[Resources](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/trait.Resource.html)**
|
||||
* primary types that you can apply *Activities* to
|
||||
* a collection of properties and *Parts*
|
||||
* **[Parts](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.Part.html)**
|
||||
* **[Parts](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/trait.Part.html)**
|
||||
* a collection of properties
|
||||
* never directly used in *Activities*
|
||||
* **[Activities](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.CallBuilder.html)**
|
||||
* **[Activities](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/trait.CallBuilder.html)**
|
||||
* operations to apply to *Resources*
|
||||
|
||||
All *structures* are marked with applicable traits to further categorize them and ease browsing.
|
||||
@@ -128,17 +128,17 @@ match result {
|
||||
```
|
||||
## Handling Errors
|
||||
|
||||
All errors produced by the system are provided either as [Result](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/enum.Result.html) enumeration as return value of
|
||||
All errors produced by the system are provided either as [Result](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
|
||||
[Hub Delegate](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/enum.Result.html), should be
|
||||
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.ResponseResult.html), it will return that by default.
|
||||
If such a method also supports a [Response Result](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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 +148,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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.Delegate.html) to the
|
||||
[Method Builder](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/trait.Delegate.html) to the
|
||||
[Method Builder](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
|
||||
The [delegate trait](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.RequestValue.html) and
|
||||
[decodable](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/trait.RequestValue.html) and
|
||||
[decodable](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.Part.html) which are identifiable by name, which will be sent to
|
||||
Most optionals are are considered [Parts](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
|
||||
Using [method builders](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/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-cloudtasks2_beta2/1.0.6+20170926/google_cloudtasks2_beta2/trait.RequestValue.html) are moved
|
||||
* [request values](https://docs.rs/google-cloudtasks2_beta2/1.0.6+20171208/google_cloudtasks2_beta2/trait.RequestValue.html) are moved
|
||||
|
||||
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user