Skip to main content

BatchTranslateTextRequest

Struct BatchTranslateTextRequest 

Source
#[non_exhaustive]
pub struct BatchTranslateTextRequest { pub parent: String, pub source_language_code: String, pub target_language_codes: Vec<String>, pub models: HashMap<String, String>, pub input_configs: Vec<InputConfig>, pub output_config: Option<OutputConfig>, pub glossaries: HashMap<String, TranslateTextGlossaryConfig>, pub labels: HashMap<String, String>, /* private fields */ }
Expand description

The batch translation request.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§parent: String

Required. Location to make a call. Must refer to a caller’s project.

Format: projects/{project-number-or-id}/locations/{location-id}.

The global location is not supported for batch translation.

Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

§source_language_code: String

Required. Source language code. Supported language codes are listed in Language Support.

§target_language_codes: Vec<String>

Required. Specify up to 10 language codes here. Supported language codes are listed in Language Support.

§models: HashMap<String, String>

Optional. The models to use for translation. Map’s key is target language code. Map’s value is model name. Value can be a built-in general model, or an AutoML Translation model.

The value format depends on model type:

  • AutoML Translation models: projects/{project-number-or-id}/locations/{location-id}/models/{model-id}

  • General (built-in) models: projects/{project-number-or-id}/locations/{location-id}/models/general/nmt,

If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.

§input_configs: Vec<InputConfig>

Required. Input configurations. The total number of files matched should be <= 100. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.

§output_config: Option<OutputConfig>

Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don’t generate output for duplicate inputs.

§glossaries: HashMap<String, TranslateTextGlossaryConfig>

Optional. Glossaries to be applied for translation. It’s keyed by target language code.

§labels: HashMap<String, String>

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

See https://cloud.google.com/translate/docs/advanced/labels for more information.

Implementations§

Source§

impl BatchTranslateTextRequest

Source

pub fn new() -> Self

Source

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

§Example
let x = BatchTranslateTextRequest::new().set_parent("example");
Source

pub fn set_source_language_code<T: Into<String>>(self, v: T) -> Self

Sets the value of source_language_code.

§Example
let x = BatchTranslateTextRequest::new().set_source_language_code("example");
Source

pub fn set_target_language_codes<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of target_language_codes.

§Example
let x = BatchTranslateTextRequest::new().set_target_language_codes(["a", "b", "c"]);
Source

pub fn set_models<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of models.

§Example
let x = BatchTranslateTextRequest::new().set_models([
    ("key0", "abc"),
    ("key1", "xyz"),
]);
Source

pub fn set_input_configs<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<InputConfig>,

Sets the value of input_configs.

§Example
use google_cloud_translation_v3::model::InputConfig;
let x = BatchTranslateTextRequest::new()
    .set_input_configs([
        InputConfig::default()/* use setters */,
        InputConfig::default()/* use (different) setters */,
    ]);
Source

pub fn set_output_config<T>(self, v: T) -> Self
where T: Into<OutputConfig>,

Sets the value of output_config.

§Example
use google_cloud_translation_v3::model::OutputConfig;
let x = BatchTranslateTextRequest::new().set_output_config(OutputConfig::default()/* use setters */);
Source

pub fn set_or_clear_output_config<T>(self, v: Option<T>) -> Self
where T: Into<OutputConfig>,

Sets or clears the value of output_config.

§Example
use google_cloud_translation_v3::model::OutputConfig;
let x = BatchTranslateTextRequest::new().set_or_clear_output_config(Some(OutputConfig::default()/* use setters */));
let x = BatchTranslateTextRequest::new().set_or_clear_output_config(None::<OutputConfig>);
Source

pub fn set_glossaries<T, K, V>(self, v: T) -> Self

Sets the value of glossaries.

§Example
use google_cloud_translation_v3::model::TranslateTextGlossaryConfig;
let x = BatchTranslateTextRequest::new().set_glossaries([
    ("key0", TranslateTextGlossaryConfig::default()/* use setters */),
    ("key1", TranslateTextGlossaryConfig::default()/* use (different) setters */),
]);
Source

pub fn set_labels<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

§Example
let x = BatchTranslateTextRequest::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

Trait Implementations§

Source§

impl Clone for BatchTranslateTextRequest

Source§

fn clone(&self) -> BatchTranslateTextRequest

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BatchTranslateTextRequest

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for BatchTranslateTextRequest

Source§

fn default() -> BatchTranslateTextRequest

Returns the “default value” for a type. Read more
Source§

impl Message for BatchTranslateTextRequest

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for BatchTranslateTextRequest

Source§

fn eq(&self, other: &BatchTranslateTextRequest) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for BatchTranslateTextRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,