Struct google_translate2::TranslationListCall

pub struct TranslationListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Translates input text, returning translated text.

A builder for the list method supported by a translation resource. It is not used directly, but through a TranslationMethods instance.

Example

Instantiate a resource method builder

 
// 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.translations().list("q", "target")
             .source("dolores")
             .model("kasd")
             .format("accusam")
             .add_cid("takimata")
             .doit();

Implementations

impl<'a, C, A> TranslationListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn doit(self) -> Result<(Response, TranslationsListResponse)>

Perform the operation you have build so far.

pub fn add_q(self, new_value: &str) -> TranslationListCall<'a, C, A>

The input text to translate. Repeat this parameter to perform translation operations on multiple text inputs.

Append the given value to the q query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn target(self, new_value: &str) -> TranslationListCall<'a, C, A>

The language to use for translation of the input text, set to one of the language codes listed in Language Support.

Sets the target query property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn source(self, new_value: &str) -> TranslationListCall<'a, C, A>

The language of the source text, set to one of the language codes listed in Language Support. If the source language is not specified, the API will attempt to identify the source language automatically and return it within the response.

Sets the source query property to the given value.

pub fn model(self, new_value: &str) -> TranslationListCall<'a, C, A>

The model type requested for this translation. Valid values are listed in public documentation.

Sets the model query property to the given value.

pub fn format(self, new_value: &str) -> TranslationListCall<'a, C, A>

The format of the source text, in either HTML (default) or plain-text. A value of "html" indicates HTML and a value of "text" indicates plain-text.

Sets the format query property to the given value.

pub fn add_cid(self, new_value: &str) -> TranslationListCall<'a, C, A>

The customization id for translate

Append the given value to the cid query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> TranslationListCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> TranslationListCall<'a, C, A> where
    T: AsRef<str>, 

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• bearer_token (query-string) - OAuth bearer token.
• pp (query-boolean) - Pretty-print response.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(self, scope: T) -> TranslationListCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for TranslationListCall<'a, C, A>