Struct aws_sdk_translate::operation::translate_document::builders::TranslateDocumentFluentBuilder

source · 
pub struct TranslateDocumentFluentBuilder { /* private fields */ }
Expand description

Fluent builder constructing a request to TranslateDocument.

Translates the input document from the source language to the target language. This synchronous operation supports text, HTML, or Word documents as the input document. TranslateDocument supports translations from English to any supported language, and from any supported language to English. Therefore, specify either the source language code or the target language code as “en” (English).

If you set the Formality parameter, the request will fail if the target language does not support formality. For a list of target languages that support formality, see Setting formality.

Implementations§

source§

impl TranslateDocumentFluentBuilder

source

pub fn as_input(&self) -> &TranslateDocumentInputBuilder

Access the TranslateDocument as a reference.

source

pub async fn send( self ) -> Result<TranslateDocumentOutput, SdkError<TranslateDocumentError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn customize( self ) -> CustomizableOperation<TranslateDocumentOutput, TranslateDocumentError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

source

pub fn document(self, input: Document) -> Self

The content and content type for the document to be translated. The document size must not exceed 100 KB.

source

pub fn set_document(self, input: Option<Document>) -> Self

The content and content type for the document to be translated. The document size must not exceed 100 KB.

source

pub fn get_document(&self) -> &Option<Document>

The content and content type for the document to be translated. The document size must not exceed 100 KB.

source

pub fn terminology_names(self, input: impl Into<String>) -> Self

Appends an item to TerminologyNames.

To override the contents of this collection use set_terminology_names.

The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

source

pub fn set_terminology_names(self, input: Option<Vec<String>>) -> Self

The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

source

pub fn get_terminology_names(&self) -> &Option<Vec<String>>

The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

source

pub fn source_language_code(self, input: impl Into<String>) -> Self

The language code for the language of the source text. For a list of supported language codes, see Supported languages.

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

source

pub fn set_source_language_code(self, input: Option<String>) -> Self

The language code for the language of the source text. For a list of supported language codes, see Supported languages.

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

source

pub fn get_source_language_code(&self) -> &Option<String>

The language code for the language of the source text. For a list of supported language codes, see Supported languages.

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

source

pub fn target_language_code(self, input: impl Into<String>) -> Self

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

source

pub fn set_target_language_code(self, input: Option<String>) -> Self

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

source

pub fn get_target_language_code(&self) -> &Option<String>

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

source

pub fn settings(self, input: TranslationSettings) -> Self

Settings to configure your translation output. You can configure the following options:

  • Brevity: not supported.

  • Formality: sets the formality level of the output text.

  • Profanity: masks profane words and phrases in your translation output.

source

pub fn set_settings(self, input: Option<TranslationSettings>) -> Self

Settings to configure your translation output. You can configure the following options:

  • Brevity: not supported.

  • Formality: sets the formality level of the output text.

  • Profanity: masks profane words and phrases in your translation output.

source

pub fn get_settings(&self) -> &Option<TranslationSettings>

Settings to configure your translation output. You can configure the following options:

  • Brevity: not supported.

  • Formality: sets the formality level of the output text.

  • Profanity: masks profane words and phrases in your translation output.

Trait Implementations§

source§

impl Clone for TranslateDocumentFluentBuilder

source§

fn clone(&self) -> TranslateDocumentFluentBuilder

Returns a copy 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 TranslateDocumentFluentBuilder

source§

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

Formats the value using the given formatter. Read more

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> 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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>,

§

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