com.amazonaws.services.translate.model

Class TranslationSettings

java.lang.Object

com.amazonaws.services.translate.model.TranslationSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TranslationSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Settings that configure the translation output.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TranslationSettings()

Method Summary

Modifier and Type	Method and Description
TranslationSettings	clone()
boolean	equals(Object obj)
String	getFormality() You can optionally specify the desired level of formality for real-time translations to supported target languages.
String	getProfanity() Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setFormality(String formality) You can optionally specify the desired level of formality for real-time translations to supported target languages.
void	setProfanity(String profanity) Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.
String	toString() Returns a string representation of this object.
TranslationSettings	withFormality(Formality formality) You can optionally specify the desired level of formality for real-time translations to supported target languages.
TranslationSettings	withFormality(String formality) You can optionally specify the desired level of formality for real-time translations to supported target languages.
TranslationSettings	withProfanity(Profanity profanity) Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.
TranslationSettings	withProfanity(String profanity) Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TranslationSettings

public TranslationSettings()

Method Detail

setFormality

public void setFormality(String formality)

You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Parameters:

formality - You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

See Also:

Formality

getFormality

public String getFormality()

You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Returns:

You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

See Also:

Formality

withFormality

public TranslationSettings withFormality(String formality)

You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Parameters:

formality - You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Formality

withFormality

public TranslationSettings withFormality(Formality formality)

You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Parameters:

formality - You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Formality

setProfanity

public void setProfanity(String profanity)

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Parameters:

profanity - Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

See Also:

Profanity

getProfanity

public String getProfanity()

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Returns:

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

See Also:

Profanity

withProfanity

public TranslationSettings withProfanity(String profanity)

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Parameters:

profanity - Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Profanity

withProfanity

public TranslationSettings withProfanity(Profanity profanity)

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Parameters:

profanity - Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Profanity

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public TranslationSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo