java.lang.Object
- software.amazon.awssdk.services.connect.model.Vocabulary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Vocabulary.Builder,Vocabulary>

@Generated("software.amazon.awssdk:codegen")
public final class Vocabulary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Vocabulary.Builder,Vocabulary>

Contains information about a custom vocabulary.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Vocabulary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the custom vocabulary.
`static Vocabulary.Builder`	`builder()`
`String`	`content()`	The content of the custom vocabulary in plain-text format with a table of values.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()`	The reason why the custom vocabulary was not created.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`id()`	The identifier of the custom vocabulary.
`VocabularyLanguageCode`	`languageCode()`	The language code of the vocabulary entries.
`String`	`languageCodeAsString()`	The language code of the vocabulary entries.
`Instant`	`lastModifiedTime()`	The timestamp when the custom vocabulary was last modified.
`String`	`name()`	A unique name of the custom vocabulary.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Vocabulary.Builder>`	`serializableBuilderClass()`
`VocabularyState`	`state()`	The current state of the custom vocabulary.
`String`	`stateAsString()`	The current state of the custom vocabulary.
`Map<String,String>`	`tags()`	The tags used to organize, track, or control access for this resource.
`Vocabulary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    A unique name of the custom vocabulary.
    
    Returns:
    
    A unique name of the custom vocabulary.
  - id
```
public final String id()
```
    The identifier of the custom vocabulary.
    
    Returns:
    
    The identifier of the custom vocabulary.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the custom vocabulary.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the custom vocabulary.
  - languageCode
```
public final VocabularyLanguageCode languageCode()
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return VocabularyLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    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
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return VocabularyLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    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
  - state
```
public final VocabularyState state()
```
    The current state of the custom vocabulary.
    
    If the service returns an enum value that is not available in the current SDK version, state will return VocabularyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - stateAsString
```
public final String stateAsString()
```
    The current state of the custom vocabulary.
    
    If the service returns an enum value that is not available in the current SDK version, state will return VocabularyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the custom vocabulary.
    
    See Also:
    
    VocabularyState
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    The timestamp when the custom vocabulary was last modified.
    
    Returns:
    
    The timestamp when the custom vocabulary was last modified.
  - failureReason
```
public final String failureReason()
```
    The reason why the custom vocabulary was not created.
    
    Returns:
    
    The reason why the custom vocabulary was not created.
  - content
```
public final 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:
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - toBuilder
```
public Vocabulary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Vocabulary.Builder,Vocabulary>
  - builder
```
public static Vocabulary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Vocabulary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Vocabulary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

id

arn

languageCode

languageCodeAsString

state

stateAsString

lastModifiedTime

failureReason

content

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields