com.amazonaws.services.translate.model.TranslationSettings Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.translate.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Optional settings that configure the translation output. Use these settings for real time translations and
* asynchronous translation jobs.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TranslationSettings implements Serializable, Cloneable, StructuredPojo {
/**
*
* You can optionally specify the desired level of formality for 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.
*
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported
* target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
*
*/
private String formality;
/**
*
* 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 don't support
* profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity masking. If
* any of the target languages don't support profanity masking, the translation job won't mask profanity for any
* target language.
*
*/
private String profanity;
/**
*
* You can optionally specify the desired level of formality for 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.
*
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported
* target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
*
*
* @param formality
* You can optionally specify the desired level of formality for 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.
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any
* unsupported target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
* @see Formality
*/
public void setFormality(String formality) {
this.formality = formality;
}
/**
*
* You can optionally specify the desired level of formality for 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.
*
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported
* target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
*
*
* @return You can optionally specify the desired level of formality for 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.
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any
* unsupported target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
* @see Formality
*/
public String getFormality() {
return this.formality;
}
/**
*
* You can optionally specify the desired level of formality for 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.
*
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported
* target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
*
*
* @param formality
* You can optionally specify the desired level of formality for 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.
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any
* unsupported target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Formality
*/
public TranslationSettings withFormality(String formality) {
setFormality(formality);
return this;
}
/**
*
* You can optionally specify the desired level of formality for 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.
*
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported
* target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
*
*
* @param formality
* You can optionally specify the desired level of formality for 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.
*
* If you specify multiple target languages for the job, translate ignores the formality setting for any
* unsupported target language.
*
*
* For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Formality
*/
public TranslationSettings withFormality(Formality formality) {
this.formality = formality.toString();
return this;
}
/**
*
* 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 don't support
* profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity masking. If
* any of the target languages don't support profanity masking, the translation job won't mask profanity for any
* target language.
*
*
* @param 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 don't
* support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity
* masking. If any of the target languages don't support profanity masking, the translation job won't mask
* profanity for any target language.
* @see Profanity
*/
public void setProfanity(String profanity) {
this.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 don't support
* profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity masking. If
* any of the target languages don't support profanity masking, the translation job won't mask profanity for any
* target language.
*
*
* @return 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 don't
* support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity
* masking. If any of the target languages don't support profanity masking, the translation job won't mask
* profanity for any target language.
* @see Profanity
*/
public String getProfanity() {
return this.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 don't support
* profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity masking. If
* any of the target languages don't support profanity masking, the translation job won't mask profanity for any
* target language.
*
*
* @param 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 don't
* support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity
* masking. If any of the target languages don't support profanity masking, the translation job won't mask
* profanity for any target language.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Profanity
*/
public TranslationSettings withProfanity(String profanity) {
setProfanity(profanity);
return this;
}
/**
*
* 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 don't support
* profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity masking. If
* any of the target languages don't support profanity masking, the translation job won't mask profanity for any
* target language.
*
*
* @param 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 don't
* support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
*
*
* If you specify multiple target languages for the job, all the target languages must support profanity
* masking. If any of the target languages don't support profanity masking, the translation job won't mask
* profanity for any target language.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Profanity
*/
public TranslationSettings withProfanity(Profanity profanity) {
this.profanity = profanity.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFormality() != null)
sb.append("Formality: ").append(getFormality()).append(",");
if (getProfanity() != null)
sb.append("Profanity: ").append(getProfanity());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TranslationSettings == false)
return false;
TranslationSettings other = (TranslationSettings) obj;
if (other.getFormality() == null ^ this.getFormality() == null)
return false;
if (other.getFormality() != null && other.getFormality().equals(this.getFormality()) == false)
return false;
if (other.getProfanity() == null ^ this.getProfanity() == null)
return false;
if (other.getProfanity() != null && other.getProfanity().equals(this.getProfanity()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFormality() == null) ? 0 : getFormality().hashCode());
hashCode = prime * hashCode + ((getProfanity() == null) ? 0 : getProfanity().hashCode());
return hashCode;
}
@Override
public TranslationSettings clone() {
try {
return (TranslationSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.translate.model.transform.TranslationSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}