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; use this URI to view or download the vocabulary.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If VocabularyState is FAILED, FailureReason contains information about why the vocabulary request failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode() The language code you selected for your custom vocabulary.
String	languageCodeAsString() The language code you selected for your custom vocabulary.
Instant	lastModifiedTime() The date and time the specified vocabulary was last modified.
List<SdkField<?>>	sdkFields()
static Class<? extends GetVocabularyResponse.Builder>	serializableBuilderClass()
GetVocabularyResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vocabularyName() The name of the custom vocabulary you requested information about.
VocabularyState	vocabularyState() The processing state of your custom vocabulary.
String	vocabularyStateAsString() The processing state of your custom 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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

vocabularyName

public final String vocabularyName()

The name of the custom vocabulary you requested information about.

Returns:

The name of the custom vocabulary you requested information about.

languageCode

public final LanguageCode languageCode()

The language code you selected for your custom vocabulary.

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 you selected for your custom vocabulary.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code you selected for your custom vocabulary.

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 you selected for your custom vocabulary.

See Also:

LanguageCode

vocabularyState

public final VocabularyState vocabularyState()

The processing state of your custom 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 your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.

See Also:

VocabularyState

vocabularyStateAsString

public final String vocabularyStateAsString()

The processing state of your custom 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 your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.

See Also:

VocabularyState

lastModifiedTime

public final Instant lastModifiedTime()

The date and time the specified vocabulary was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

Returns:

The date and time the specified vocabulary was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

failureReason

public final String failureReason()

If VocabularyState is FAILED, FailureReason contains information about why the vocabulary request failed. See also: Common Errors.

Returns:

If VocabularyState is FAILED, FailureReason contains information about why the vocabulary request failed. See also: Common Errors.

downloadUri

public final String downloadUri()

The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.

Returns:

The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.

toBuilder

public GetVocabularyResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetVocabularyResponse.Builder,GetVocabularyResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetVocabularyResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo