[−][src]Crate google_translate3
This documentation was generated from Translate crate version 1.0.14+20200629, where 20200629 is the exact revision of the translate:v3 schema built by the mako code generator v1.0.14.
Everything else about the Translate v3 API can be found at the official documentation site. The original source code is on github.
Features
Handle the following Resources with ease from the central hub ...
- projects
- detect language, get supported languages, locations batch translate text, locations detect language, locations get, locations get supported languages, locations glossaries create, locations glossaries delete, locations glossaries get, locations glossaries list, locations list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations operations wait, locations translate text and translate text
Not what you are looking for ? Find all other Google APIs in their Rust documentation index.
Structure of this Library
The API is structured into the following primary items:
- Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
- Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
- a collection of properties
- never directly used in Activities
- Activities
- operations to apply to Resources
All structures are marked with applicable traits to further categorize them and ease browsing.
Generally speaking, you can invoke Activities like this:
let r = hub.resource().activity(...).doit()
Or specifically ...
let r = hub.projects().locations_glossaries_create(...).doit() let r = hub.projects().locations_glossaries_delete(...).doit() let r = hub.projects().locations_operations_wait(...).doit() let r = hub.projects().locations_batch_translate_text(...).doit() let r = hub.projects().locations_operations_get(...).doit()
The resource() and activity(...) calls create builders. The second one dealing with Activities
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
specified right away (i.e. (...)), whereas all optional ones can be build up as desired.
The doit() method performs the actual communication with the server and returns the respective result.
Usage
Setting up your Project
To use this library, you would put the following lines into your Cargo.toml file:
[dependencies]
google-translate3 = "*"
# 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
extern crate hyper; extern crate hyper_rustls; extern crate yup_oauth2 as oauth2; extern crate google_translate3 as translate3; use translate3::Glossary; use translate3::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use translate3::Translate; // Get an ApplicationSecret instance by some means. It contains the `client_id` and // `client_secret`, among other things. let secret: ApplicationSecret = Default::default(); // Instantiate the authenticator. It will choose a suitable authentication flow for you, // unless you replace `None` with the desired Flow. // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and // retrieve them from storage. let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), <MemoryStorage as Default>::default(), None); let mut hub = Translate::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); // 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 = Glossary::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().locations_glossaries_create(req, "parent") .doit(); match result { Err(e) => match e { // The Error enum provides details about what exactly happened. // You can also just use its `Debug`, `Display` or `Error` traits Error::HttpError(_) |Error::MissingAPIKey |Error::MissingToken(_) |Error::Cancelled |Error::UploadSizeLimitExceeded(_, _) |Error::Failure(_) |Error::BadRequest(_) |Error::FieldClash(_) |Error::JsonDecodeError(_, _) => println!("{}", e), }, Ok(res) => println!("Success: {:?}", res), }
Handling Errors
All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.
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, should be
read by you to obtain the media.
If such a method also supports a Response Result, 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").
Methods supporting uploads can do so using up to 2 different protocols:
simple and resumable. The distinctiveness of each is represented by customized
doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.
Customization and Callbacks
You may alter the way an doit() method is called by providing a delegate to the
Method Builder 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 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 and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts 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, 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 are handed by copy
- strings are passed as
&str - request values are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
Structs
| BatchTranslateTextRequest | The batch translation request. |
| CancelOperationRequest | The request message for Operations.CancelOperation. |
| Chunk | |
| ContentRange | Implements the Content-Range header, for serialization only |
| DefaultDelegate | A delegate with a conservative default implementation, which is used if no other delegate is set. |
| DetectLanguageRequest | The request message for language detection. |
| DetectLanguageResponse | The response message for language detection. |
| DetectedLanguage | The response message for language detection. |
| DummyNetworkStream | |
| Empty | A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: |
| ErrorResponse | A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound |
| GcsDestination | The Google Cloud Storage location for the output content. |
| GcsSource | The Google Cloud Storage location for the input content. |
| Glossary | Represents a glossary built from user provided data. |
| GlossaryInputConfig | Input configuration for glossaries. |
| InputConfig | Input configuration for BatchTranslateText request. |
| JsonServerError | A utility type which can decode a server response that indicates error |
| LanguageCodePair | Used with unidirectional glossaries. |
| LanguageCodesSet | Used with equivalent term set glossaries. |
| ListGlossariesResponse | Response message for ListGlossaries. |
| ListLocationsResponse | The response message for Locations.ListLocations. |
| ListOperationsResponse | The response message for Operations.ListOperations. |
| Location | A resource that represents Google Cloud Platform location. |
| MethodInfo | Contains information about an API request. |
| MultiPartReader | Provides a |
| Operation | This resource represents a long-running operation that is the result of a network API call. |
| OutputConfig | Output configuration for BatchTranslateText request. |
| ProjectDetectLanguageCall | Detects the language of text within a request. |
| ProjectGetSupportedLanguageCall | Returns a list of supported languages for translation. |
| ProjectLocationBatchTranslateTextCall | Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. |
| ProjectLocationDetectLanguageCall | Detects the language of text within a request. |
| ProjectLocationGetCall | Gets information about a location. |
| ProjectLocationGetSupportedLanguageCall | Returns a list of supported languages for translation. |
| ProjectLocationGlossaryCreateCall | Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist. |
| ProjectLocationGlossaryDeleteCall | Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist. |
| ProjectLocationGlossaryGetCall | Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist. |
| ProjectLocationGlossaryListCall | Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. |
| ProjectLocationListCall | Lists information about the supported locations for this service. |
| ProjectLocationOperationCancelCall | Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
|
| ProjectLocationOperationDeleteCall | Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
|
| ProjectLocationOperationGetCall | Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. |
| ProjectLocationOperationListCall | Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns |
| ProjectLocationOperationWaitCall | Waits for the specified long-running operation until it is done or reaches
at most a specified timeout, returning the latest state. If the operation
is already done, the latest state is immediately returned. If the timeout
specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
|
| ProjectLocationTranslateTextCall | Translates input text and returns translated text. |
| ProjectMethods | A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
| ProjectTranslateTextCall | Translates input text and returns translated text. |
| RangeResponseHeader | |
| ResumableUploadHelper | A utility type to perform a resumable upload from start to end. |
| ServerError | |
| ServerMessage | |
| Status | The |
| SupportedLanguage | A single supported language response corresponds to information related to one supported language. |
| SupportedLanguages | The response message for discovering supported languages. |
| Translate | Central instance to access all Translate related resource activities |
| TranslateTextGlossaryConfig | Configures which glossary should be used for a specific target language, and defines options for applying that glossary. |
| TranslateTextRequest | The request message for synchronous translation. |
| TranslateTextResponse | There is no detailed description. |
| Translation | A single translation response. |
| WaitOperationRequest | The request message for Operations.WaitOperation. |
| XUploadContentType | The |
Enums
| Error | |
| Scope | Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |
Traits
| CallBuilder | Identifies types which represent builders for a particular resource method |
| Delegate | A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation. |
| Hub | Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily. |
| MethodsBuilder | Identifies types for building methods of a particular resource type |
| NestedType | Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness. |
| Part | Identifies types which are only used as part of other types, which
usually are carrying the |
| ReadSeek | A utility to specify reader types which provide seeking capabilities too |
| RequestValue | Identifies types which are used in API requests. |
| Resource | Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API. |
| ResponseResult | Identifies types which are used in API responses. |
| ToParts | A trait for all types that can convert themselves into a parts string |
| UnusedType | Identifies types which are not actually used by the API This might be a bug within the google API schema. |
Functions
| remove_json_null_values |
Type Definitions
| Result | A universal result type used as return for all calls. |