software.amazon.awssdk.services.transcribe.model

Class VocabularyInfo

java.lang.Object

software.amazon.awssdk.services.transcribe.model.VocabularyInfo

All Implemented Interfaces:

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

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

Provides information about a custom vocabulary. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VocabularyInfo.Builder

Method Summary

Modifier and Type	Method and Description
static VocabularyInfo.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode() The language code of the vocabulary entries.
String	languageCodeAsString() The language code of the vocabulary entries.
Instant	lastModifiedTime() The date and time that the vocabulary was last modified.
List<SdkField<?>>	sdkFields()
static Class<? extends VocabularyInfo.Builder>	serializableBuilderClass()
VocabularyInfo.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	vocabularyName() The name of the vocabulary.
VocabularyState	vocabularyState() The processing state of the vocabulary.
String	vocabularyStateAsString() The processing state of the vocabulary.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

vocabularyName

public String vocabularyName()

The name of the vocabulary.

Returns:

The name of the vocabulary.

languageCode

public LanguageCode languageCode()

The language code of the vocabulary entries.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code of the vocabulary entries.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

The language code of the vocabulary entries.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code of the vocabulary entries.

See Also:

LanguageCode

lastModifiedTime

public Instant lastModifiedTime()

The date and time that the vocabulary was last modified.

Returns:

The date and time that the vocabulary was last modified.

vocabularyState

public VocabularyState vocabularyState()

The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.

If the service returns an enum value that is not available in the current SDK version, vocabularyState will return VocabularyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyStateAsString().

Returns:

The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.

See Also:

VocabularyState

vocabularyStateAsString

public String vocabularyStateAsString()

The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.

If the service returns an enum value that is not available in the current SDK version, vocabularyState will return VocabularyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyStateAsString().

Returns:

The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.

See Also:

VocabularyState

toBuilder

public VocabularyInfo.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<VocabularyInfo.Builder,VocabularyInfo>

Returns:

a builder for type T

builder

public static VocabularyInfo.Builder builder()

serializableBuilderClass

public static Class<? extends VocabularyInfo.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.