* Creates a custom vocabulary associated with your Amazon Connect instance. You * can set a custom vocabulary to be your default vocabulary for a given * language. Contact Lens for Amazon Connect uses the default vocabulary in * post-call and real-time contact analysis sessions for that language. *
*/ public class CreateVocabularyRequest extends AmazonWebServiceRequest implements Serializable { /** ** A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. If not provided, the Amazon Web Services SDK * populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is * received more than once with same client token, subsequent requests * return the previous response without creating a vocabulary again. *
*
* Constraints:
* Length: - 500
*/
private String clientToken;
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *
*
* Constraints:
* Length: 1 - 100
*/
private String instanceId;
/**
*
* A unique name of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
*/
private String vocabularyName;
/**
*
* The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see What is Amazon Transcribe? *
*
* Constraints:
* Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE,
* en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP,
* ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
*/
private String languageCode;
/**
*
* The content of the custom vocabulary in plain-text format with a table of
* values. Each row in the table represents a word or a phrase, described
* with Phrase, IPA, SoundsLike, and
* DisplayAs fields. Separate the fields with TAB characters.
* The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
*
* Constraints:
* Length: 1 - 60000
*/
private String content;
/**
*
* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
*/ private java.util.Map* A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. If not provided, the Amazon Web Services SDK * populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is * received more than once with same client token, subsequent requests * return the previous response without creating a vocabulary again. *
*
* Constraints:
* Length: - 500
*
* @return
* A unique, case-sensitive identifier that you provide to ensure * the idempotency of the request. If not provided, the Amazon Web * Services SDK populates this field. For more information about * idempotency, see Making retries safe with idempotent APIs. If a create * request is received more than once with same client token, * subsequent requests return the previous response without creating * a vocabulary again. *
*/ public String getClientToken() { return clientToken; } /** ** A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. If not provided, the Amazon Web Services SDK * populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is * received more than once with same client token, subsequent requests * return the previous response without creating a vocabulary again. *
*
* Constraints:
* Length: - 500
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure * the idempotency of the request. If not provided, the Amazon * Web Services SDK populates this field. For more information * about idempotency, see Making retries safe with idempotent APIs. If a create * request is received more than once with same client token, * subsequent requests return the previous response without * creating a vocabulary again. *
*/ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** ** A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. If not provided, the Amazon Web Services SDK * populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is * received more than once with same client token, subsequent requests * return the previous response without creating a vocabulary again. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 500
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure * the idempotency of the request. If not provided, the Amazon * Web Services SDK populates this field. For more information * about idempotency, see Making retries safe with idempotent APIs. If a create * request is received more than once with same client token, * subsequent requests return the previous response without * creating a vocabulary again. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withClientToken(String clientToken) { this.clientToken = clientToken; return this; } /** ** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *
*
* Constraints:
* Length: 1 - 100
*
* @return
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
*/ public String getInstanceId() { return instanceId; } /** ** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *
*
* Constraints:
* Length: 1 - 100
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
*/ public void setInstanceId(String instanceId) { this.instanceId = instanceId; } /** ** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 100
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withInstanceId(String instanceId) { this.instanceId = instanceId; return this; } /** ** A unique name of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
*
* @return
* A unique name of the custom vocabulary. *
*/ public String getVocabularyName() { return vocabularyName; } /** ** A unique name of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
*
* @param vocabularyName
* A unique name of the custom vocabulary. *
*/ public void setVocabularyName(String vocabularyName) { this.vocabularyName = vocabularyName; } /** ** A unique name of the custom vocabulary. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
*
* @param vocabularyName
* A unique name of the custom vocabulary. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withVocabularyName(String vocabularyName) { this.vocabularyName = vocabularyName; return this; } /** ** The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see What is Amazon Transcribe? *
*
* Constraints:
* Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE,
* en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP,
* ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
*
* @return
* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *
* @see VocabularyLanguageCode */ public String getLanguageCode() { return languageCode; } /** ** The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see What is Amazon Transcribe? *
*
* Constraints:
* Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE,
* en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP,
* ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
*
* @param languageCode
* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *
* @see VocabularyLanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** ** The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see What is Amazon Transcribe? *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE,
* en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP,
* ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
*
* @param languageCode
* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *
* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyLanguageCode */ public CreateVocabularyRequest withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** ** The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see What is Amazon Transcribe? *
*
* Constraints:
* Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE,
* en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP,
* ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
*
* @param languageCode
* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *
* @see VocabularyLanguageCode */ public void setLanguageCode(VocabularyLanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** ** The language code of the vocabulary entries. For a list of languages and * their corresponding language codes, see What is Amazon Transcribe? *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE,
* en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP,
* ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
*
* @param languageCode
* The language code of the vocabulary entries. For a list of * languages and their corresponding language codes, see What is Amazon Transcribe? *
* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyLanguageCode */ public CreateVocabularyRequest withLanguageCode(VocabularyLanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** *
* The content of the custom vocabulary in plain-text format with a table of
* values. Each row in the table represents a word or a phrase, described
* with Phrase, IPA, SoundsLike, and
* DisplayAs fields. Separate the fields with TAB characters.
* The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
*
* Constraints:
* Length: 1 - 60000
*
* @return
* The content of the custom vocabulary in plain-text format with a
* table of values. Each row in the table represents a word or a
* phrase, described with Phrase, IPA,
* SoundsLike, and DisplayAs fields.
* Separate the fields with TAB characters. The size limit is 50KB.
* For more information, see Create a custom vocabulary using a table.
*
* The content of the custom vocabulary in plain-text format with a table of
* values. Each row in the table represents a word or a phrase, described
* with Phrase, IPA, SoundsLike, and
* DisplayAs fields. Separate the fields with TAB characters.
* The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
*
* Constraints:
* Length: 1 - 60000
*
* @param content
* The content of the custom vocabulary in plain-text format with
* a table of values. Each row in the table represents a word or
* a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields.
* Separate the fields with TAB characters. The size limit is
* 50KB. For more information, see Create a custom vocabulary using a table.
*
* The content of the custom vocabulary in plain-text format with a table of
* values. Each row in the table represents a word or a phrase, described
* with Phrase, IPA, SoundsLike, and
* DisplayAs fields. Separate the fields with TAB characters.
* The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 60000
*
* @param content
* The content of the custom vocabulary in plain-text format with
* a table of values. Each row in the table represents a word or
* a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields.
* Separate the fields with TAB characters. The size limit is
* 50KB. For more information, see Create a custom vocabulary using a table.
*
* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
* * @return* The tags used to organize, track, or control access for this * resource. For example, { "tags": {"key1":"value1", * "key2":"value2"} }. *
*/ public java.util.Map* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
* * @param tags* The tags used to organize, track, or control access for this * resource. For example, { "tags": {"key1":"value1", * "key2":"value2"} }. *
*/ public void setTags(java.util.Map* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
** Returns a reference to this object so that method calls can be chained * together. * * @param tags
* The tags used to organize, track, or control access for this * resource. For example, { "tags": {"key1":"value1", * "key2":"value2"} }. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withTags(java.util.Map* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
*
* The method adds a new key-value pair into Tags parameter, and returns a
* reference to this object so that method calls can be chained together.
*
* @param key The key of the entry to be added into Tags.
* @param value The corresponding value of the entry to be added into Tags.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public CreateVocabularyRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public CreateVocabularyRequest clearTagsEntries() {
this.tags = null;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getClientToken() != null)
sb.append("ClientToken: " + getClientToken() + ",");
if (getInstanceId() != null)
sb.append("InstanceId: " + getInstanceId() + ",");
if (getVocabularyName() != null)
sb.append("VocabularyName: " + getVocabularyName() + ",");
if (getLanguageCode() != null)
sb.append("LanguageCode: " + getLanguageCode() + ",");
if (getContent() != null)
sb.append("Content: " + getContent() + ",");
if (getTags() != null)
sb.append("Tags: " + getTags());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
hashCode = prime * hashCode
+ ((getVocabularyName() == null) ? 0 : getVocabularyName().hashCode());
hashCode = prime * hashCode
+ ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getContent() == null) ? 0 : getContent().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateVocabularyRequest == false)
return false;
CreateVocabularyRequest other = (CreateVocabularyRequest) obj;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null
&& other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getInstanceId() == null ^ this.getInstanceId() == null)
return false;
if (other.getInstanceId() != null
&& other.getInstanceId().equals(this.getInstanceId()) == false)
return false;
if (other.getVocabularyName() == null ^ this.getVocabularyName() == null)
return false;
if (other.getVocabularyName() != null
&& other.getVocabularyName().equals(this.getVocabularyName()) == false)
return false;
if (other.getLanguageCode() == null ^ this.getLanguageCode() == null)
return false;
if (other.getLanguageCode() != null
&& other.getLanguageCode().equals(this.getLanguageCode()) == false)
return false;
if (other.getContent() == null ^ this.getContent() == null)
return false;
if (other.getContent() != null && other.getContent().equals(this.getContent()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
}