Update to latest versions of API declarations

This commit is contained in:
Sebastian Thiel
2018-10-13 13:49:14 +02:00
parent 5a67475b54
commit 255c7f5ad5
1508 changed files with 819225 additions and 838421 deletions

View File

@@ -4,14 +4,15 @@
[package]
name = "google-firestore1_beta1"
version = "1.0.7+20171205"
version = "1.0.7+20181001"
authors = ["Sebastian Thiel <byronimo@gmail.com>"]
description = "A complete library to interact with Firestore (protocol v1beta1)"
repository = "https://github.com/Byron/google-apis-rs/tree/master/gen/firestore1_beta1"
homepage = "https://cloud.google.com/firestore"
documentation = "https://docs.rs/google-firestore1_beta1/1.0.7+20171205"
documentation = "https://docs.rs/google-firestore1_beta1/1.0.7+20181001"
license = "MIT"
keywords = ["firestore", "google", "protocol", "web", "api"]
autobins = false
[dev-dependencies]

View File

@@ -5,16 +5,16 @@ DO NOT EDIT !
-->
The `google-firestore1_beta1` library allows access to all features of the *Google Firestore* service.
This documentation was generated from *Firestore* crate version *1.0.7+20171205*, where *20171205* is the exact revision of the *firestore:v1beta1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.7*.
This documentation was generated from *Firestore* crate version *1.0.7+20181001*, where *20181001* is the exact revision of the *firestore:v1beta1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.7*.
Everything else about the *Firestore* *v1_beta1* 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_beta1/1.0.7+20171205/google_firestore1_beta1/struct.Firestore.html) ...
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.Firestore.html) ...
* projects
* [*databases documents batch get*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentBatchGetCall.html), [*databases documents begin transaction*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentBeginTransactionCall.html), [*databases documents commit*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentCommitCall.html), [*databases documents create document*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentCreateDocumentCall.html), [*databases documents delete*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentDeleteCall.html), [*databases documents get*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentGetCall.html), [*databases documents list*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentListCall.html), [*databases documents list collection ids*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentListCollectionIdCall.html), [*databases documents listen*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentListenCall.html), [*databases documents patch*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentPatchCall.html), [*databases documents rollback*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentRollbackCall.html), [*databases documents run query*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentRunQueryCall.html), [*databases documents write*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseDocumentWriteCall.html), [*databases indexes create*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseIndexeCreateCall.html), [*databases indexes delete*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseIndexeDeleteCall.html), [*databases indexes get*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseIndexeGetCall.html) and [*databases indexes list*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/struct.ProjectDatabaseIndexeListCall.html)
* [*databases documents batch get*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentBatchGetCall.html), [*databases documents begin transaction*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentBeginTransactionCall.html), [*databases documents commit*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentCommitCall.html), [*databases documents create document*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentCreateDocumentCall.html), [*databases documents delete*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentDeleteCall.html), [*databases documents get*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentGetCall.html), [*databases documents list*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentListCall.html), [*databases documents list collection ids*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentListCollectionIdCall.html), [*databases documents listen*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentListenCall.html), [*databases documents patch*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentPatchCall.html), [*databases documents rollback*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentRollbackCall.html), [*databases documents run query*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentRunQueryCall.html), [*databases documents write*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseDocumentWriteCall.html), [*databases export documents*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseExportDocumentCall.html), [*databases import documents*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseImportDocumentCall.html), [*databases indexes create*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseIndexeCreateCall.html), [*databases indexes delete*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseIndexeDeleteCall.html), [*databases indexes get*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseIndexeGetCall.html) and [*databases indexes list*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.ProjectDatabaseIndexeListCall.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_beta1/1.0.7+20171205/google_firestore1_beta1/struct.Firestore.html)**
* **[Hub](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/struct.Firestore.html)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/trait.CallBuilder.html)
* **[Resources](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/trait.Resource.html)**
* creates [*Method Builders*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/trait.CallBuilder.html)
* **[Resources](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/trait.Resource.html)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/trait.Part.html)**
* **[Parts](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/trait.Part.html)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/trait.CallBuilder.html)**
* **[Activities](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/trait.CallBuilder.html)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -47,9 +47,9 @@ let r = hub.resource().activity(...).doit()
Or specifically ...
```ignore
let r = hub.projects().databases_documents_get(...).doit()
let r = hub.projects().databases_documents_create_document(...).doit()
let r = hub.projects().databases_documents_patch(...).doit()
let r = hub.projects().databases_import_documents(...).doit()
let r = hub.projects().databases_export_documents(...).doit()
let r = hub.projects().databases_indexes_create(...).doit()
```
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
@@ -66,6 +66,14 @@ To use this library, you would put the following lines into your `Cargo.toml` fi
```toml
[dependencies]
google-firestore1_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"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"
```
## A complete example
@@ -75,7 +83,7 @@ extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_firestore1_beta1 as firestore1_beta1;
use firestore1_beta1::Document;
use firestore1_beta1::GoogleFirestoreAdminV1beta1ImportDocumentsRequest;
use firestore1_beta1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
@@ -96,16 +104,12 @@ let mut hub = Firestore::new(hyper::Client::with_connector(hyper::net::HttpsConn
// 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 = Document::default();
let mut req = GoogleFirestoreAdminV1beta1ImportDocumentsRequest::default();
// 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().databases_documents_patch(req, "name")
.add_update_mask_field_paths("sit")
.add_mask_field_paths("Stet")
.current_document_update_time("sed")
.current_document_exists(false)
let result = hub.projects().databases_import_documents(req, "name")
.doit();
match result {
@@ -128,17 +132,17 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/enum.Result.html) enumeration as return value of
All errors produced by the system are provided either as [Result](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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_beta1/1.0.7+20171205/google_firestore1_beta1/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
[Hub Delegate](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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_beta1/1.0.7+20171205/google_firestore1_beta1/enum.Result.html), should be
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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_beta1/1.0.7+20171205/google_firestore1_beta1/trait.ResponseResult.html), it will return that by default.
If such a method also supports a [Response Result](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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 +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-firestore1_beta1/1.0.7+20171205/google_firestore1_beta1/trait.Delegate.html) to the
[Method Builder](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_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-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/trait.Delegate.html) to the
[Method Builder](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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_beta1/1.0.7+20171205/google_firestore1_beta1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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_beta1/1.0.7+20171205/google_firestore1_beta1/trait.RequestValue.html) and
[decodable](https://docs.rs/google-firestore1_beta1/1.0.7+20171205/google_firestore1_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 [enocodable](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/trait.RequestValue.html) and
[decodable](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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_beta1/1.0.7+20171205/google_firestore1_beta1/trait.Part.html) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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_beta1/1.0.7+20171205/google_firestore1_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-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/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_beta1/1.0.7+20171205/google_firestore1_beta1/trait.RequestValue.html) are moved
* [request values](https://docs.rs/google-firestore1_beta1/1.0.7+20181001/google_firestore1_beta1/trait.RequestValue.html) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

File diff suppressed because it is too large Load Diff