Struct gapi_grpc::google::cloud::translation::v3beta1::TranslateDocumentRequest

pub struct TranslateDocumentRequest {
    pub parent: String,
    pub source_language_code: String,
    pub target_language_code: String,
    pub document_input_config: Option<DocumentInputConfig>,
    pub document_output_config: Option<DocumentOutputConfig>,
    pub model: String,
    pub glossary_config: Option<TranslateTextGlossaryConfig>,
    pub labels: HashMap<String, String>,
}

A document translation request.

Fields

parent: String

Required. Location to make a regional call.

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

For global calls, use projects/{project-number-or-id}/locations/global or projects/{project-number-or-id}.

Non-global location is required for requests using AutoML models or custom glossaries.

Models and glossaries must be within the same region (have the same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

source_language_code: String

Optional. The BCP-47 language code of the input document if known, for example, “en-US” or “sr-Latn”. Supported language codes are listed in Language Support. If the source language isn’t specified, the API attempts to identify the source language automatically and returns the source language within the response. Source language must be specified if the request contains a glossary or a custom model.

target_language_code: String

Required. The BCP-47 language code to use for translation of the input document, set to one of the language codes listed in Language Support.

document_input_config: Option<DocumentInputConfig>

Required. Input configurations.

document_output_config: Option<DocumentOutputConfig>

Optional. Output configurations. Defines if the output file should be stored within Cloud Storage as well as the desired output format. If not provided the translated file will only be returned through a byte-stream and its output mime type will be the same as the input file’s mime type.

model: String

Optional. The model type requested for this translation.

The 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, projects/{project-number-or-id}/locations/{location-id}/models/general/base

If not provided, the default Google model (NMT) will be used for translation.

glossary_config: Option<TranslateTextGlossaryConfig>

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

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.

Trait Implementations

impl Clone for TranslateDocumentRequest

fn clone(&self) -> TranslateDocumentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TranslateDocumentRequest

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

Formats the value using the given formatter.

impl Default for TranslateDocumentRequest

fn default() -> TranslateDocumentRequest

Returns the “default value” for a type.

impl Message for TranslateDocumentRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<TranslateDocumentRequest> for TranslateDocumentRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for TranslateDocumentRequest