/* * Copyright 2010-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.connect.model; import java.io.Serializable; /** *
* Contains information about a custom vocabulary. *
*/ public class Vocabulary implements Serializable { /** ** A unique name of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
*/
private String name;
/**
*
* The identifier of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 500
*/
private String id;
/**
*
* The Amazon Resource Name (ARN) of the custom vocabulary. *
*/ private String arn; /** ** 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 current state of the custom vocabulary. *
*
* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
* DELETE_IN_PROGRESS
*/
private String state;
/**
*
* The timestamp when the custom vocabulary was last modified. *
*/ private java.util.Date lastModifiedTime; /** ** The reason why the custom vocabulary was not created. *
*/ private String failureReason; /** *
* 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.
* 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 name of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
*
* @return
* A unique name of the custom vocabulary. *
*/ public String getName() { return name; } /** ** A unique name of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 140
* Pattern: ^[0-9a-zA-Z._-]+
*
* @param name
* A unique name of the custom vocabulary. *
*/ public void setName(String name) { this.name = name; } /** ** 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 name
* A unique name of the custom vocabulary. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Vocabulary withName(String name) { this.name = name; return this; } /** ** The identifier of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 500
*
* @return
* The identifier of the custom vocabulary. *
*/ public String getId() { return id; } /** ** The identifier of the custom vocabulary. *
*
* Constraints:
* Length: 1 - 500
*
* @param id
* The identifier of the custom vocabulary. *
*/ public void setId(String id) { this.id = id; } /** ** The identifier of the custom vocabulary. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 500
*
* @param id
* The identifier of the custom vocabulary. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Vocabulary withId(String id) { this.id = id; return this; } /** ** The Amazon Resource Name (ARN) of the custom vocabulary. *
* * @return* The Amazon Resource Name (ARN) of the custom vocabulary. *
*/ public String getArn() { return arn; } /** ** The Amazon Resource Name (ARN) of the custom vocabulary. *
* * @param arn* The Amazon Resource Name (ARN) of the custom vocabulary. *
*/ public void setArn(String arn) { this.arn = arn; } /** ** The Amazon Resource Name (ARN) of the custom vocabulary. *
** Returns a reference to this object so that method calls can be chained * together. * * @param arn
* The Amazon Resource Name (ARN) of the custom vocabulary. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Vocabulary withArn(String arn) { this.arn = arn; 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 Vocabulary 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 Vocabulary withLanguageCode(VocabularyLanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** ** The current state of the custom vocabulary. *
*
* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
* DELETE_IN_PROGRESS
*
* @return
* The current state of the custom vocabulary. *
* @see VocabularyState */ public String getState() { return state; } /** ** The current state of the custom vocabulary. *
*
* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
* DELETE_IN_PROGRESS
*
* @param state
* The current state of the custom vocabulary. *
* @see VocabularyState */ public void setState(String state) { this.state = state; } /** ** The current state of the custom vocabulary. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
* DELETE_IN_PROGRESS
*
* @param state
* The current state of the custom vocabulary. *
* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyState */ public Vocabulary withState(String state) { this.state = state; return this; } /** ** The current state of the custom vocabulary. *
*
* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
* DELETE_IN_PROGRESS
*
* @param state
* The current state of the custom vocabulary. *
* @see VocabularyState */ public void setState(VocabularyState state) { this.state = state.toString(); } /** ** The current state of the custom vocabulary. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED,
* DELETE_IN_PROGRESS
*
* @param state
* The current state of the custom vocabulary. *
* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyState */ public Vocabulary withState(VocabularyState state) { this.state = state.toString(); return this; } /** ** The timestamp when the custom vocabulary was last modified. *
* * @return* The timestamp when the custom vocabulary was last modified. *
*/ public java.util.Date getLastModifiedTime() { return lastModifiedTime; } /** ** The timestamp when the custom vocabulary was last modified. *
* * @param lastModifiedTime* The timestamp when the custom vocabulary was last modified. *
*/ public void setLastModifiedTime(java.util.Date lastModifiedTime) { this.lastModifiedTime = lastModifiedTime; } /** ** The timestamp when the custom vocabulary was last modified. *
** Returns a reference to this object so that method calls can be chained * together. * * @param lastModifiedTime
* The timestamp when the custom vocabulary was last modified. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Vocabulary withLastModifiedTime(java.util.Date lastModifiedTime) { this.lastModifiedTime = lastModifiedTime; return this; } /** ** The reason why the custom vocabulary was not created. *
* * @return* The reason why the custom vocabulary was not created. *
*/ public String getFailureReason() { return failureReason; } /** ** The reason why the custom vocabulary was not created. *
* * @param failureReason* The reason why the custom vocabulary was not created. *
*/ public void setFailureReason(String failureReason) { this.failureReason = failureReason; } /** ** The reason why the custom vocabulary was not created. *
** Returns a reference to this object so that method calls can be chained * together. * * @param failureReason
* The reason why the custom vocabulary was not created. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Vocabulary withFailureReason(String failureReason) { this.failureReason = failureReason; 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.
* 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. 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.
* 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. 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.
* 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. 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 Vocabulary 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 Vocabulary 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 Vocabulary 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 (getName() != null)
sb.append("Name: " + getName() + ",");
if (getId() != null)
sb.append("Id: " + getId() + ",");
if (getArn() != null)
sb.append("Arn: " + getArn() + ",");
if (getLanguageCode() != null)
sb.append("LanguageCode: " + getLanguageCode() + ",");
if (getState() != null)
sb.append("State: " + getState() + ",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: " + getLastModifiedTime() + ",");
if (getFailureReason() != null)
sb.append("FailureReason: " + getFailureReason() + ",");
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 + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode
+ ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode
+ ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
hashCode = prime * hashCode
+ ((getFailureReason() == null) ? 0 : getFailureReason().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 Vocabulary == false)
return false;
Vocabulary other = (Vocabulary) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == 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.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null
&& other.getLastModifiedTime().equals(this.getLastModifiedTime()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null
&& other.getFailureReason().equals(this.getFailureReason()) == 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;
}
}