software.amazon.awssdk.services.transcribe.model

Class CreateMedicalVocabularyResponse

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.CreateMedicalVocabularyResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateMedicalVocabularyResponse.Builder,CreateMedicalVocabularyResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateMedicalVocabularyResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CreateMedicalVocabularyResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
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 for the entries in your custom vocabulary.
String	languageCodeAsString() The language code for the entries in your custom vocabulary.
Instant	lastModifiedTime() The date and time that you created the vocabulary.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateMedicalVocabularyResponse.Builder>	serializableBuilderClass()
CreateMedicalVocabularyResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	vocabularyName() The name of the vocabulary.
VocabularyState	vocabularyState() The processing state of your custom vocabulary in Amazon Transcribe Medical.
String	vocabularyStateAsString() The processing state of your custom vocabulary in Amazon Transcribe Medical.

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 final String vocabularyName()

The name of the vocabulary. The name must be unique within an Amazon Web Services account and is case sensitive.

Returns:

The name of the vocabulary. The name must be unique within an Amazon Web Services account and is case sensitive.

languageCode

public final LanguageCode languageCode()

The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.

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 for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.

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 for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.

See Also:

LanguageCode

vocabularyState

public final VocabularyState vocabularyState()

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

See Also:

VocabularyState

vocabularyStateAsString

public final String vocabularyStateAsString()

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

See Also:

VocabularyState

lastModifiedTime

public final Instant lastModifiedTime()

The date and time that you created the vocabulary.

Returns:

The date and time that you created the vocabulary.

failureReason

public final 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.

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static CreateMedicalVocabularyResponse.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

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 final 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.