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

regen all APIs

Browse Source
This commit is contained in:
Sebastian Thiel
2024-03-05 19:02:07 +01:00
parent ca974aa0a5
commit 55badfe90e
1998 changed files with 490545 additions and 148021 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
gen/documentai1/README.md
View File

@@ -5,18 +5,18 @@ DO NOT EDIT !
-->
The `google-documentai1` library allows access to all features of the *Google Document* service.
This documentation was generated from *Document* crate version *5.0.3+20230117*, where *20230117* is the exact revision of the *documentai:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.3*.
This documentation was generated from *Document* crate version *5.0.3+20240223*, where *20240223* is the exact revision of the *documentai:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.3*.
Everything else about the *Document* *v1* API can be found at the
[official documentation site](https://cloud.google.com/document-ai/docs/).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/Document) ...
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/Document) ...
* operations
* [*delete*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::OperationDeleteCall)
* [*delete*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::OperationDeleteCall)
* projects
* [*locations fetch processor types*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationFetchProcessorTypeCall), [*locations get*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationGetCall), [*locations list*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationListCall), [*locations operations cancel*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationOperationCancelCall), [*locations operations get*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationOperationGetCall), [*locations operations list*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationOperationListCall), [*locations processor types get*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorTypeGetCall), [*locations processor types list*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorTypeListCall), [*locations processors batch process*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorBatchProcesCall), [*locations processors create*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorCreateCall), [*locations processors delete*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorDeleteCall), [*locations processors disable*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorDisableCall), [*locations processors enable*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorEnableCall), [*locations processors get*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorGetCall), [*locations processors human review config review document*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorHumanReviewConfigReviewDocumentCall), [*locations processors list*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorListCall), [*locations processors process*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcesCall), [*locations processors processor versions batch process*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionBatchProcesCall), [*locations processors processor versions delete*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionDeleteCall), [*locations processors processor versions deploy*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionDeployCall), [*locations processors processor versions evaluate processor version*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionEvaluateProcessorVersionCall), [*locations processors processor versions evaluations get*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionEvaluationGetCall), [*locations processors processor versions evaluations list*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionEvaluationListCall), [*locations processors processor versions get*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionGetCall), [*locations processors processor versions list*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionListCall), [*locations processors processor versions process*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionProcesCall), [*locations processors processor versions train*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionTrainCall), [*locations processors processor versions undeploy*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorProcessorVersionUndeployCall), [*locations processors set default processor version*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectLocationProcessorSetDefaultProcessorVersionCall) and [*operations get*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/api::ProjectOperationGetCall)
* [*locations fetch processor types*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationFetchProcessorTypeCall), [*locations get*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationGetCall), [*locations list*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationListCall), [*locations operations cancel*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationOperationCancelCall), [*locations operations get*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationOperationGetCall), [*locations operations list*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationOperationListCall), [*locations processor types get*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorTypeGetCall), [*locations processor types list*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorTypeListCall), [*locations processors batch process*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorBatchProcesCall), [*locations processors create*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorCreateCall), [*locations processors delete*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorDeleteCall), [*locations processors disable*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorDisableCall), [*locations processors enable*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorEnableCall), [*locations processors get*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorGetCall), [*locations processors human review config review document*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorHumanReviewConfigReviewDocumentCall), [*locations processors list*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorListCall), [*locations processors process*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcesCall), [*locations processors processor versions batch process*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionBatchProcesCall), [*locations processors processor versions delete*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionDeleteCall), [*locations processors processor versions deploy*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionDeployCall), [*locations processors processor versions evaluate processor version*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionEvaluateProcessorVersionCall), [*locations processors processor versions evaluations get*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionEvaluationGetCall), [*locations processors processor versions evaluations list*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionEvaluationListCall), [*locations processors processor versions get*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionGetCall), [*locations processors processor versions list*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionListCall), [*locations processors processor versions process*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionProcesCall), [*locations processors processor versions train*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionTrainCall), [*locations processors processor versions undeploy*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorProcessorVersionUndeployCall), [*locations processors set default processor version*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectLocationProcessorSetDefaultProcessorVersionCall) and [*operations get*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/api::ProjectOperationGetCall)
@@ -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-documentai1/5.0.3+20230117/google_documentai1/Document)**
* **[Hub](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/Document)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/client::CallBuilder)
* **[Resources](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/client::Resource)**
* creates [*Method Builders*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/client::CallBuilder)
* **[Resources](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/client::Part)**
* **[Parts](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/client::CallBuilder)**
* **[Activities](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/client::CallBuilder)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -139,17 +139,17 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/client::Result) enumeration as return value of
All errors produced by the system are provided either as [Result](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/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-documentai1/5.0.3+20230117/google_documentai1/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
[Hub Delegate](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/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-documentai1/5.0.3+20230117/google_documentai1/client::Result), should be
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/client::ResponseResult), it will return that by default.
If such a method also supports a [Response Result](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/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")`.
@@ -159,29 +159,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-documentai1/5.0.3+20230117/google_documentai1/client::Delegate) to the
[Method Builder](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/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-documentai1/5.0.3+20240223/google_documentai1/client::Delegate) to the
[Method Builder](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/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-documentai1/5.0.3+20230117/google_documentai1/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/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-documentai1/5.0.3+20230117/google_documentai1/client::RequestValue) and
[decodable](https://docs.rs/google-documentai1/5.0.3+20230117/google_documentai1/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-documentai1/5.0.3+20240223/google_documentai1/client::RequestValue) and
[decodable](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/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-documentai1/5.0.3+20230117/google_documentai1/client::Part) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/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-documentai1/5.0.3+20230117/google_documentai1/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
Using [method builders](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/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-documentai1/5.0.3+20230117/google_documentai1/client::RequestValue) are moved
* [request values](https://docs.rs/google-documentai1/5.0.3+20240223/google_documentai1/client::RequestValue) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.