software.amazon.awssdk.services.transcribe.model

Class GetVocabularyResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.transcribe.model.TranscribeResponse

software.amazon.awssdk.services.transcribe.model.GetVocabularyResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetVocabularyResponse.Builder,GetVocabularyResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetVocabularyResponse
extends TranscribeResponse
implements ToCopyableBuilder<GetVocabularyResponse.Builder,GetVocabularyResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetVocabularyResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetVocabularyResponse.Builder	builder()
String	downloadUri() The S3 location where the vocabulary is stored.
boolean	equals(Object obj)
String	failureReason() If the VocabularyState field is FAILED, this field contains information about why the job failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
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 GetVocabularyResponse.Builder>	serializableBuilderClass()
GetVocabularyResponse.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 to return.
VocabularyState	vocabularyState() The processing state of the vocabulary.
String	vocabularyStateAsString() The processing state of the vocabulary.

Methods inherited from class software.amazon.awssdk.services.transcribe.model.TranscribeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 to return.

Returns:

The name of the vocabulary to return.

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

vocabularyState

public VocabularyState vocabularyState()

The processing state of the vocabulary.

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.

See Also:

VocabularyState

vocabularyStateAsString

public String vocabularyStateAsString()

The processing state of the vocabulary.

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.

See Also:

VocabularyState

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.

failureReason

public String failureReason()

If the VocabularyState field is FAILED, this field contains information about why the job failed.

Returns:

If the VocabularyState field is FAILED, this field contains information about why the job failed.

downloadUri

public String downloadUri()

The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.

Returns:

The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.

toBuilder

public GetVocabularyResponse.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<GetVocabularyResponse.Builder,GetVocabularyResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetVocabularyResponse.Builder builder()

serializableBuilderClass

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

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.