Vocabulary (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Vocabulary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a custom vocabulary.

See Also:

AWS API Documentation, 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(String key, String value)` Add a single Tags entry
`Vocabulary`	`clearTagsEntries()` Removes all the entries added into Tags.
`Vocabulary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the custom vocabulary.
`String`	`getContent()` The content of the custom vocabulary in plain-text format with a table of values.
`String`	`getFailureReason()` The reason why the custom vocabulary was not created.
`String`	`getId()` The identifier of the custom vocabulary.
`String`	`getLanguageCode()` The language code of the vocabulary entries.
`Date`	`getLastModifiedTime()` The timestamp when the custom vocabulary was last modified.
`String`	`getName()` A unique name of the custom vocabulary.
`String`	`getState()` The current state of the custom vocabulary.
`Map<String,String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the custom vocabulary.
`void`	`setContent(String content)` The content of the custom vocabulary in plain-text format with a table of values.
`void`	`setFailureReason(String failureReason)` The reason why the custom vocabulary was not created.
`void`	`setId(String id)` The identifier of the custom vocabulary.
`void`	`setLanguageCode(String languageCode)` The language code of the vocabulary entries.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The timestamp when the custom vocabulary was last modified.
`void`	`setName(String name)` A unique name of the custom vocabulary.
`void`	`setState(String state)` The current state of the custom vocabulary.
`void`	`setTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`String`	`toString()` Returns a string representation of this object.
`Vocabulary`	`withArn(String arn)` The Amazon Resource Name (ARN) of the custom vocabulary.
`Vocabulary`	`withContent(String content)` The content of the custom vocabulary in plain-text format with a table of values.
`Vocabulary`	`withFailureReason(String failureReason)` The reason why the custom vocabulary was not created.
`Vocabulary`	`withId(String id)` The identifier of the custom vocabulary.
`Vocabulary`	`withLanguageCode(String languageCode)` The language code of the vocabulary entries.
`Vocabulary`	`withLanguageCode(VocabularyLanguageCode languageCode)` The language code of the vocabulary entries.
`Vocabulary`	`withLastModifiedTime(Date lastModifiedTime)` The timestamp when the custom vocabulary was last modified.
`Vocabulary`	`withName(String name)` A unique name of the custom vocabulary.
`Vocabulary`	`withState(String state)` The current state of the custom vocabulary.
`Vocabulary`	`withState(VocabularyState state)` The current state of the custom vocabulary.
`Vocabulary`	`withTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.

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

- Constructor Detail
  - Vocabulary
```
public Vocabulary()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    A unique name of the custom vocabulary.
    
    Parameters:
    
    name - A unique name of the custom vocabulary.
  - getName
```
public String getName()
```
    A unique name of the custom vocabulary.
    
    Returns:
    
    A unique name of the custom vocabulary.
  - withName
```
public Vocabulary withName(String name)
```
    A unique name of the custom vocabulary.
    
    Parameters:
    
    name - A unique name of the custom vocabulary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The identifier of the custom vocabulary.
    
    Parameters:
    
    id - The identifier of the custom vocabulary.
  - getId
```
public String getId()
```
    The identifier of the custom vocabulary.
    
    Returns:
    
    The identifier of the custom vocabulary.
  - withId
```
public Vocabulary withId(String id)
```
    The identifier of the custom vocabulary.
    
    Parameters:
    
    id - The identifier of the custom vocabulary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the custom vocabulary.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the custom vocabulary.
  - withArn
```
public Vocabulary withArn(String arn)
```
    The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    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
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    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
  - withLanguageCode
```
public Vocabulary withLanguageCode(String languageCode)
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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?
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyLanguageCode
  - setState
```
public void setState(String state)
```
    The current state of the custom vocabulary.
    
    Parameters:
    
    state - The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - getState
```
public String getState()
```
    The current state of the custom vocabulary.
    
    Returns:
    
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - withState
```
public Vocabulary withState(String state)
```
    The current state of the custom vocabulary.
    
    Parameters:
    
    state - The current state of the custom vocabulary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyState
  - withState
```
public Vocabulary withState(VocabularyState state)
```
    The current state of the custom vocabulary.
    
    Parameters:
    
    state - The current state of the custom vocabulary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VocabularyState
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The timestamp when the custom vocabulary was last modified.
    
    Parameters:
    
    lastModifiedTime - The timestamp when the custom vocabulary was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The timestamp when the custom vocabulary was last modified.
    
    Returns:
    
    The timestamp when the custom vocabulary was last modified.
  - withLastModifiedTime
```
public Vocabulary withLastModifiedTime(Date lastModifiedTime)
```
    The timestamp when the custom vocabulary was last modified.
    
    Parameters:
    
    lastModifiedTime - The timestamp when the custom vocabulary was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    The reason why the custom vocabulary was not created.
    
    Parameters:
    
    failureReason - The reason why the custom vocabulary was not created.
  - getFailureReason
```
public String getFailureReason()
```
    The reason why the custom vocabulary was not created.
    
    Returns:
    
    The reason why the custom vocabulary was not created.
  - withFailureReason
```
public Vocabulary withFailureReason(String failureReason)
```
    The reason why the custom vocabulary was not created.
    
    Parameters:
    
    failureReason - The reason why the custom vocabulary was not created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContent
```
public void setContent(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.
    
    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.
  - getContent
```
public 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.
    
    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.
  - withContent
```
public Vocabulary withContent(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,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(Map<String,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(Map<String,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"} }.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Vocabulary addTagsEntry(String key,
                               String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Vocabulary clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Vocabulary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class Vocabulary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Vocabulary

Method Detail

setName

getName

withName

setId

getId

withId

setArn

getArn

withArn

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setState

getState

withState

withState

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setFailureReason

getFailureReason

withFailureReason

setContent

getContent

withContent

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall