Package software.amazon.awssdk.services.transcribe.model

Class GetMedicalVocabularyResponse

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.GetMedicalVocabularyResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetMedicalVocabularyResponse.Builder,GetMedicalVocabularyResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetMedicalVocabularyResponse extends TranscribeResponse implements ToCopyableBuilder<GetMedicalVocabularyResponse.Builder,GetMedicalVocabularyResponse>

  • Method Details

    • vocabularyName

      public final String vocabularyName()

      The name of the custom medical vocabulary you requested information about.

      Returns:
      The name of the custom medical vocabulary you requested information about.

    • languageCode

      public final LanguageCode languageCode()

      The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with 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 you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with 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 you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
      See Also:

    • vocabularyState

      public final VocabularyState vocabularyState()

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

    • vocabularyStateAsString

      public final String vocabularyStateAsString()

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

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time the specified custom medical 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 custom medical 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 custom medical vocabulary request failed. See also: Common Errors.

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

    • downloadUri

      public final String downloadUri()

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

      Returns:
      The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary.

    • toBuilder

      public GetMedicalVocabularyResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetMedicalVocabularyResponse.Builder,GetMedicalVocabularyResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GetMedicalVocabularyResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo