Vocabulary (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.services.connect.model.Vocabulary

All Implemented Interfaces:

java.io.Serializable
```
public class Vocabulary
extends java.lang.Object
implements java.io.Serializable
```
Contains information about a custom vocabulary.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Vocabulary()

Constructors
Constructor and Description
`Vocabulary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Vocabulary`	`addTagsEntry(java.lang.String key, java.lang.String value)` The tags used to organize, track, or control access for this resource.
`Vocabulary`	`clearTagsEntries()` Removes all the entries added into Tags.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getArn()` The Amazon Resource Name (ARN) of the custom vocabulary.
`java.lang.String`	`getContent()` The content of the custom vocabulary in plain-text format with a table of values.
`java.lang.String`	`getFailureReason()` The reason why the custom vocabulary was not created.
`java.lang.String`	`getId()` The identifier of the custom vocabulary.
`java.lang.String`	`getLanguageCode()` The language code of the vocabulary entries.
`java.util.Date`	`getLastModifiedTime()` The timestamp when the custom vocabulary was last modified.
`java.lang.String`	`getName()` A unique name of the custom vocabulary.
`java.lang.String`	`getState()` The current state of the custom vocabulary.
`java.util.Map<java.lang.String,java.lang.String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`int`	`hashCode()`
`void`	`setArn(java.lang.String arn)` The Amazon Resource Name (ARN) of the custom vocabulary.
`void`	`setContent(java.lang.String content)` The content of the custom vocabulary in plain-text format with a table of values.
`void`	`setFailureReason(java.lang.String failureReason)` The reason why the custom vocabulary was not created.
`void`	`setId(java.lang.String id)` The identifier of the custom vocabulary.
`void`	`setLanguageCode(java.lang.String languageCode)` The language code of the vocabulary entries.
`void`	`setLanguageCode(VocabularyLanguageCode languageCode)` The language code of the vocabulary entries.
`void`	`setLastModifiedTime(java.util.Date lastModifiedTime)` The timestamp when the custom vocabulary was last modified.
`void`	`setName(java.lang.String name)` A unique name of the custom vocabulary.
`void`	`setState(java.lang.String state)` The current state of the custom vocabulary.
`void`	`setState(VocabularyState state)` The current state of the custom vocabulary.
`void`	`setTags(java.util.Map<java.lang.String,java.lang.String> tags)` The tags used to organize, track, or control access for this resource.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Vocabulary`	`withArn(java.lang.String arn)` The Amazon Resource Name (ARN) of the custom vocabulary.
`Vocabulary`	`withContent(java.lang.String content)` The content of the custom vocabulary in plain-text format with a table of values.
`Vocabulary`	`withFailureReason(java.lang.String failureReason)` The reason why the custom vocabulary was not created.
`Vocabulary`	`withId(java.lang.String id)` The identifier of the custom vocabulary.
`Vocabulary`	`withLanguageCode(java.lang.String languageCode)` The language code of the vocabulary entries.
`Vocabulary`	`withLanguageCode(VocabularyLanguageCode languageCode)` The language code of the vocabulary entries.
`Vocabulary`	`withLastModifiedTime(java.util.Date lastModifiedTime)` The timestamp when the custom vocabulary was last modified.
`Vocabulary`	`withName(java.lang.String name)` A unique name of the custom vocabulary.
`Vocabulary`	`withState(java.lang.String state)` The current state of the custom vocabulary.
`Vocabulary`	`withState(VocabularyState state)` The current state of the custom vocabulary.
`Vocabulary`	`withTags(java.util.Map<java.lang.String,java.lang.String> tags)` The tags used to organize, track, or control access for this resource.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Vocabulary
```
public Vocabulary()
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    A unique name of the custom vocabulary.
    
    Constraints:
    Length: 1 - 140
    Pattern: ^[0-9a-zA-Z._-]+
    
    Returns:
    
    A unique name of the custom vocabulary.
  - setName
```
public void setName(java.lang.String name)
```
    A unique name of the custom vocabulary.
    
    Constraints:
    Length: 1 - 140
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    name -
    A unique name of the custom vocabulary.
  - withName
```
public Vocabulary withName(java.lang.String 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._-]+
    
    Parameters:
    
    name -
    A unique name of the custom vocabulary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getId
```
public java.lang.String getId()
```
    The identifier of the custom vocabulary.
    
    Constraints:
    Length: 1 - 500
    
    Returns:
    
    The identifier of the custom vocabulary.
  - setId
```
public void setId(java.lang.String id)
```
    The identifier of the custom vocabulary.
    
    Constraints:
    Length: 1 - 500
    
    Parameters:
    
    id -
    The identifier of the custom vocabulary.
  - withId
```
public Vocabulary withId(java.lang.String 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
    
    Parameters:
    
    id -
    The identifier of the custom vocabulary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getArn
```
public java.lang.String getArn()
```
    The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the custom vocabulary.
  - setArn
```
public void setArn(java.lang.String arn)
```
    The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Parameters:
    
    arn -
    The Amazon Resource Name (ARN) of the custom vocabulary.
  - withArn
```
public Vocabulary withArn(java.lang.String arn)
```
    The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    arn -
    The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLanguageCode
```
public java.lang.String getLanguageCode()
```
    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
    
    Returns:
    
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    See Also:
    
    VocabularyLanguageCode
  - setLanguageCode
```
public void setLanguageCode(java.lang.String 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
    
    Parameters:
    
    languageCode -
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    See Also:
    
    VocabularyLanguageCode
  - withLanguageCode
```
public Vocabulary withLanguageCode(java.lang.String 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
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
    
    See Also:
    
    VocabularyLanguageCode
  - setLanguageCode
```
public void setLanguageCode(VocabularyLanguageCode 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
    
    Parameters:
    
    languageCode -
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    See Also:
    
    VocabularyLanguageCode
  - withLanguageCode
```
public Vocabulary withLanguageCode(VocabularyLanguageCode 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
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
    
    See Also:
    
    VocabularyLanguageCode
  - getState
```
public java.lang.String getState()
```
    The current state of the custom vocabulary.
    
    Constraints:
    Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
    
    Returns:
    
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - setState
```
public void setState(java.lang.String state)
```
    The current state of the custom vocabulary.
    
    Constraints:
    Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
    
    Parameters:
    
    state -
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - withState
```
public Vocabulary withState(java.lang.String 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
    
    Parameters:
    
    state -
    The current state of the custom vocabulary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VocabularyState
  - setState
```
public void setState(VocabularyState state)
```
    The current state of the custom vocabulary.
    
    Constraints:
    Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
    
    Parameters:
    
    state -
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - withState
```
public Vocabulary withState(VocabularyState 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
    
    Parameters:
    
    state -
    The current state of the custom vocabulary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VocabularyState
  - getLastModifiedTime
```
public java.util.Date getLastModifiedTime()
```
    The timestamp when the custom vocabulary was last modified.
    
    Returns:
    
    The timestamp when the custom vocabulary was last modified.
  - setLastModifiedTime
```
public void setLastModifiedTime(java.util.Date lastModifiedTime)
```
    The timestamp when the custom vocabulary was last modified.
    
    Parameters:
    
    lastModifiedTime -
    The timestamp when the custom vocabulary was last modified.
  - withLastModifiedTime
```
public Vocabulary withLastModifiedTime(java.util.Date lastModifiedTime)
```
    The timestamp when the custom vocabulary was last modified.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lastModifiedTime -
    The timestamp when the custom vocabulary was last modified.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFailureReason
```
public java.lang.String getFailureReason()
```
    The reason why the custom vocabulary was not created.
    
    Returns:
    
    The reason why the custom vocabulary was not created.
  - setFailureReason
```
public void setFailureReason(java.lang.String failureReason)
```
    The reason why the custom vocabulary was not created.
    
    Parameters:
    
    failureReason -
    The reason why the custom vocabulary was not created.
  - withFailureReason
```
public Vocabulary withFailureReason(java.lang.String failureReason)
```
    The reason why the custom vocabulary was not created.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    failureReason -
    The reason why the custom vocabulary was not created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getContent
```
public java.lang.String getContent()
```
    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
    
    Returns:
    
    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.
  - setContent
```
public void setContent(java.lang.String 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.
    
    Constraints:
    Length: 1 - 60000
    
    Parameters:
    
    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.
  - withContent
```
public Vocabulary withContent(java.lang.String 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 60000
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public java.util.Map<java.lang.String,java.lang.String> getTags()
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - setTags
```
public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - withTags
```
public Vocabulary withTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    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.
    
    Parameters:
    
    tags -
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addTagsEntry
```
public Vocabulary addTagsEntry(java.lang.String key,
                               java.lang.String value)
```
    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.
    
    Parameters:
    
    key - The key of the entry to be added into Tags.
    
    value - The corresponding value of the entry to be added into Tags.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearTagsEntries
```
public Vocabulary clearTagsEntries()
```
    Removes all the entries added into Tags.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class Vocabulary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Vocabulary

Method Detail

getName

setName

withName

getId

setId

withId

getArn

setArn

withArn

getLanguageCode

setLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

getState

setState

withState

setState

withState

getLastModifiedTime

setLastModifiedTime

withLastModifiedTime

getFailureReason

setFailureReason

withFailureReason

getContent

setContent

withContent

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

hashCode

equals