Package software.amazon.awssdk.services.connect.model

Class VocabularySummary

java.lang.Object

software.amazon.awssdk.services.connect.model.VocabularySummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VocabularySummary.Builder,VocabularySummary>

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

Contains summary information about the custom vocabulary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VocabularySummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the custom vocabulary.
static VocabularySummary.Builder	builder()
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()
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 VocabularySummary.Builder>	serializableBuilderClass()
VocabularyState	state()	The current state of the custom vocabulary.
String	stateAsString()	The current state of the custom vocabulary.
VocabularySummary.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.

toBuilder

public VocabularySummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VocabularySummary.Builder,VocabularySummary>

builder

public static VocabularySummary.Builder builder()

serializableBuilderClass

public static Class<? extends VocabularySummary.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