mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-07 03:56:42 +01:00
regen all APIs
This commit is contained in:
@@ -5,18 +5,18 @@ DO NOT EDIT !
|
||||
-->
|
||||
The `google-taskqueue1_beta2` library allows access to all features of the *Google taskqueue* service.
|
||||
|
||||
This documentation was generated from *taskqueue* crate version *2.0.5+20160428*, where *20160428* is the exact revision of the *taskqueue:v1beta2* schema built by the [mako](http://www.makotemplates.org/) code generator *v2.0.5*.
|
||||
This documentation was generated from *taskqueue* crate version *2.0.8+20160428*, where *20160428* is the exact revision of the *taskqueue:v1beta2* schema built by the [mako](http://www.makotemplates.org/) code generator *v2.0.8*.
|
||||
|
||||
Everything else about the *taskqueue* *v1_beta2* API can be found at the
|
||||
[official documentation site](https://developers.google.com/appengine/docs/python/taskqueue/rest).
|
||||
# Features
|
||||
|
||||
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/Taskqueue) ...
|
||||
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/Taskqueue) ...
|
||||
|
||||
* taskqueues
|
||||
* [*get*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::TaskqueueGetCall)
|
||||
* [tasks](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::Task)
|
||||
* [*delete*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::TaskDeleteCall), [*get*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::TaskGetCall), [*insert*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::TaskInsertCall), [*lease*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::TaskLeaseCall), [*list*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::TaskListCall), [*patch*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::TaskPatchCall) and [*update*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/api::TaskUpdateCall)
|
||||
* [*get*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::TaskqueueGetCall)
|
||||
* [tasks](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::Task)
|
||||
* [*delete*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::TaskDeleteCall), [*get*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::TaskGetCall), [*insert*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::TaskInsertCall), [*lease*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::TaskLeaseCall), [*list*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::TaskListCall), [*patch*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::TaskPatchCall) and [*update*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/api::TaskUpdateCall)
|
||||
|
||||
|
||||
|
||||
@@ -25,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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/Taskqueue)**
|
||||
* **[Hub](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/Taskqueue)**
|
||||
* a central object to maintain state and allow accessing all *Activities*
|
||||
* creates [*Method Builders*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::MethodsBuilder) which in turn
|
||||
allow access to individual [*Call Builders*](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::CallBuilder)
|
||||
* **[Resources](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::Resource)**
|
||||
* creates [*Method Builders*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::MethodsBuilder) which in turn
|
||||
allow access to individual [*Call Builders*](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::CallBuilder)
|
||||
* **[Resources](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::Resource)**
|
||||
* primary types that you can apply *Activities* to
|
||||
* a collection of properties and *Parts*
|
||||
* **[Parts](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::Part)**
|
||||
* **[Parts](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::Part)**
|
||||
* a collection of properties
|
||||
* never directly used in *Activities*
|
||||
* **[Activities](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::CallBuilder)**
|
||||
* **[Activities](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::CallBuilder)**
|
||||
* operations to apply to *Resources*
|
||||
|
||||
All *structures* are marked with applicable traits to further categorize them and ease browsing.
|
||||
@@ -133,17 +133,17 @@ match result {
|
||||
```
|
||||
## Handling Errors
|
||||
|
||||
All errors produced by the system are provided either as [Result](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::Result) enumeration as return value of
|
||||
All errors produced by the system are provided either as [Result](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
|
||||
[Hub Delegate](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::Result), should be
|
||||
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::Result), should be
|
||||
read by you to obtain the media.
|
||||
If such a method also supports a [Response Result](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::ResponseResult), it will return that by default.
|
||||
If such a method also supports a [Response Result](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/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 +153,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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::Delegate) to the
|
||||
[Method Builder](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::Delegate) to the
|
||||
[Method Builder](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
|
||||
The [delegate trait](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::RequestValue) and
|
||||
[decodable](https://docs.rs/google-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::RequestValue) and
|
||||
[decodable](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::Part) which are identifiable by name, which will be sent to
|
||||
Most optionals are are considered [Parts](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
|
||||
Using [method builders](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/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-taskqueue1_beta2/2.0.5+20160428/google_taskqueue1_beta2/client::RequestValue) are moved
|
||||
* [request values](https://docs.rs/google-taskqueue1_beta2/2.0.8+20160428/google_taskqueue1_beta2/client::RequestValue) 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