mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
update version to 1.0.10; republish 4 select crates
This commit is contained in:
@@ -5,16 +5,16 @@ DO NOT EDIT !
|
||||
-->
|
||||
The `google-firestore1` library allows access to all features of the *Google Firestore* service.
|
||||
|
||||
This documentation was generated from *Firestore* crate version *1.0.9+20190419*, where *20190419* is the exact revision of the *firestore:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.9*.
|
||||
This documentation was generated from *Firestore* crate version *1.0.10+20190419*, where *20190419* is the exact revision of the *firestore:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.10*.
|
||||
|
||||
Everything else about the *Firestore* *v1* API can be found at the
|
||||
[official documentation site](https://cloud.google.com/firestore).
|
||||
# Features
|
||||
|
||||
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.Firestore.html) ...
|
||||
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.Firestore.html) ...
|
||||
|
||||
* projects
|
||||
* [*databases collection groups fields get*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupFieldGetCall.html), [*databases collection groups fields list*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupFieldListCall.html), [*databases collection groups fields patch*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupFieldPatchCall.html), [*databases collection groups indexes create*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupIndexeCreateCall.html), [*databases collection groups indexes delete*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupIndexeDeleteCall.html), [*databases collection groups indexes get*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupIndexeGetCall.html), [*databases collection groups indexes list*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupIndexeListCall.html), [*databases documents batch get*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentBatchGetCall.html), [*databases documents begin transaction*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentBeginTransactionCall.html), [*databases documents commit*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentCommitCall.html), [*databases documents create document*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentCreateDocumentCall.html), [*databases documents delete*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentDeleteCall.html), [*databases documents get*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentGetCall.html), [*databases documents list*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentListCall.html), [*databases documents list collection ids*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentListCollectionIdCall.html), [*databases documents listen*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentListenCall.html), [*databases documents patch*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentPatchCall.html), [*databases documents rollback*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentRollbackCall.html), [*databases documents run query*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentRunQueryCall.html), [*databases documents write*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseDocumentWriteCall.html), [*databases export documents*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseExportDocumentCall.html), [*databases import documents*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseImportDocumentCall.html), [*databases operations cancel*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseOperationCancelCall.html), [*databases operations delete*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseOperationDeleteCall.html), [*databases operations get*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseOperationGetCall.html), [*databases operations list*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectDatabaseOperationListCall.html), [*locations get*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectLocationGetCall.html) and [*locations list*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/struct.ProjectLocationListCall.html)
|
||||
* [*databases collection groups fields get*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupFieldGetCall.html), [*databases collection groups fields list*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupFieldListCall.html), [*databases collection groups fields patch*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupFieldPatchCall.html), [*databases collection groups indexes create*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupIndexeCreateCall.html), [*databases collection groups indexes delete*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupIndexeDeleteCall.html), [*databases collection groups indexes get*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupIndexeGetCall.html), [*databases collection groups indexes list*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseCollectionGroupIndexeListCall.html), [*databases documents batch get*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentBatchGetCall.html), [*databases documents begin transaction*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentBeginTransactionCall.html), [*databases documents commit*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentCommitCall.html), [*databases documents create document*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentCreateDocumentCall.html), [*databases documents delete*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentDeleteCall.html), [*databases documents get*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentGetCall.html), [*databases documents list*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentListCall.html), [*databases documents list collection ids*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentListCollectionIdCall.html), [*databases documents listen*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentListenCall.html), [*databases documents patch*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentPatchCall.html), [*databases documents rollback*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentRollbackCall.html), [*databases documents run query*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentRunQueryCall.html), [*databases documents write*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseDocumentWriteCall.html), [*databases export documents*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseExportDocumentCall.html), [*databases import documents*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseImportDocumentCall.html), [*databases operations cancel*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseOperationCancelCall.html), [*databases operations delete*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseOperationDeleteCall.html), [*databases operations get*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseOperationGetCall.html), [*databases operations list*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectDatabaseOperationListCall.html), [*locations get*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectLocationGetCall.html) and [*locations list*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.ProjectLocationListCall.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-firestore1/1.0.9+20190419/google_firestore1/struct.Firestore.html)**
|
||||
* **[Hub](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/struct.Firestore.html)**
|
||||
* a central object to maintain state and allow accessing all *Activities*
|
||||
* creates [*Method Builders*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/trait.MethodsBuilder.html) which in turn
|
||||
allow access to individual [*Call Builders*](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/trait.CallBuilder.html)
|
||||
* **[Resources](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/trait.Resource.html)**
|
||||
* creates [*Method Builders*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/trait.MethodsBuilder.html) which in turn
|
||||
allow access to individual [*Call Builders*](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/trait.CallBuilder.html)
|
||||
* **[Resources](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/trait.Resource.html)**
|
||||
* primary types that you can apply *Activities* to
|
||||
* a collection of properties and *Parts*
|
||||
* **[Parts](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/trait.Part.html)**
|
||||
* **[Parts](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/trait.Part.html)**
|
||||
* a collection of properties
|
||||
* never directly used in *Activities*
|
||||
* **[Activities](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/trait.CallBuilder.html)**
|
||||
* **[Activities](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/trait.CallBuilder.html)**
|
||||
* operations to apply to *Resources*
|
||||
|
||||
All *structures* are marked with applicable traits to further categorize them and ease browsing.
|
||||
@@ -135,17 +135,17 @@ match result {
|
||||
```
|
||||
## Handling Errors
|
||||
|
||||
All errors produced by the system are provided either as [Result](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/enum.Result.html) enumeration as return value of
|
||||
All errors produced by the system are provided either as [Result](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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-firestore1/1.0.9+20190419/google_firestore1/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
|
||||
[Hub Delegate](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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-firestore1/1.0.9+20190419/google_firestore1/enum.Result.html), should be
|
||||
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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-firestore1/1.0.9+20190419/google_firestore1/trait.ResponseResult.html), it will return that by default.
|
||||
If such a method also supports a [Response Result](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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")`.
|
||||
|
||||
@@ -155,29 +155,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-firestore1/1.0.9+20190419/google_firestore1/trait.Delegate.html) to the
|
||||
[Method Builder](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/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-firestore1/1.0.10+20190419/google_firestore1/trait.Delegate.html) to the
|
||||
[Method Builder](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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-firestore1/1.0.9+20190419/google_firestore1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
|
||||
The [delegate trait](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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-firestore1/1.0.9+20190419/google_firestore1/trait.RequestValue.html) and
|
||||
[decodable](https://docs.rs/google-firestore1/1.0.9+20190419/google_firestore1/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-firestore1/1.0.10+20190419/google_firestore1/trait.RequestValue.html) and
|
||||
[decodable](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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-firestore1/1.0.9+20190419/google_firestore1/trait.Part.html) which are identifiable by name, which will be sent to
|
||||
Most optionals are are considered [Parts](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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-firestore1/1.0.9+20190419/google_firestore1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
|
||||
Using [method builders](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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-firestore1/1.0.9+20190419/google_firestore1/trait.RequestValue.html) are moved
|
||||
* [request values](https://docs.rs/google-firestore1/1.0.10+20190419/google_firestore1/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