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

Upgrade to latest API versions + code regen

Browse Source
This commit is contained in:
Sebastian Thiel
2017-12-12 14:30:54 +01:00
parent dc30217711
commit 357a0e650e
776 changed files with 356718 additions and 104442 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
gen/searchconsole1/README.md
View File

@@ -5,16 +5,16 @@ DO NOT EDIT !
-->
The `google-searchconsole1` library allows access to all features of the *Google Search Console* service.
This documentation was generated from *Search Console* crate version *1.0.6+20170926*, where *20170926* is the exact revision of the *searchconsole:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.6*.
This documentation was generated from *Search Console* crate version *1.0.6+20171211*, where *20171211* is the exact revision of the *searchconsole:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.6*.
Everything else about the *Search Console* *v1* API can be found at the
[official documentation site](https://developers.google.com/webmaster-tools/search-console-api/).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/struct.SearchConsole.html) ...
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/struct.SearchConsole.html) ...
* url testing tools
* [*mobile friendly test run*](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/struct.UrlTestingToolMobileFriendlyTestRunCall.html)
* [*mobile friendly test run*](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/struct.UrlTestingToolMobileFriendlyTestRunCall.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-searchconsole1/1.0.6+20170926/google_searchconsole1/struct.SearchConsole.html)**
* **[Hub](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/struct.SearchConsole.html)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.CallBuilder.html)
* **[Resources](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.Resource.html)**
* creates [*Method Builders*](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/trait.CallBuilder.html)
* **[Resources](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/trait.Resource.html)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.Part.html)**
* **[Parts](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/trait.Part.html)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.CallBuilder.html)**
* **[Activities](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/trait.CallBuilder.html)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -122,17 +122,17 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/enum.Result.html) enumeration as return value of
All errors produced by the system are provided either as [Result](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
[Hub Delegate](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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-searchconsole1/1.0.6+20170926/google_searchconsole1/enum.Result.html), should be
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.ResponseResult.html), it will return that by default.
If such a method also supports a [Response Result](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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")`.
@@ -142,29 +142,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-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.Delegate.html) to the
[Method Builder](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/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-searchconsole1/1.0.6+20171211/google_searchconsole1/trait.Delegate.html) to the
[Method Builder](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.RequestValue.html) and
[decodable](https://docs.rs/google-searchconsole1/1.0.6+20170926/google_searchconsole1/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-searchconsole1/1.0.6+20171211/google_searchconsole1/trait.RequestValue.html) and
[decodable](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.Part.html) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
Using [method builders](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/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-searchconsole1/1.0.6+20170926/google_searchconsole1/trait.RequestValue.html) are moved
* [request values](https://docs.rs/google-searchconsole1/1.0.6+20171211/google_searchconsole1/trait.RequestValue.html) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.