Package software.amazon.awssdk.services.transcribestreaming.model

Class MedicalAlternative

java.lang.Object
software.amazon.awssdk.services.transcribestreaming.model.MedicalAlternative
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MedicalAlternative.Builder,MedicalAlternative>
@Generated("software.amazon.awssdk:codegen") public final class MedicalAlternative extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MedicalAlternative.Builder,MedicalAlternative>

A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

See Also:

  • Method Details

    • transcript

      public final String transcript()

      Contains transcribed text.

      Returns:
      Contains transcribed text.

    • hasItems

      public final boolean hasItems()
      For responses, this returns true if the service returned a value for the Items property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • items

      public final List<MedicalItem> items()

      Contains words, phrases, or punctuation marks in your transcription output.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItems() method.

      Returns:
      Contains words, phrases, or punctuation marks in your transcription output.

    • hasEntities

      public final boolean hasEntities()
      For responses, this returns true if the service returned a value for the Entities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • entities

      public final List<MedicalEntity> entities()

      Contains entities identified as personal health information (PHI) in your transcription output.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEntities() method.

      Returns:
      Contains entities identified as personal health information (PHI) in your transcription output.

    • toBuilder

      public MedicalAlternative.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<MedicalAlternative.Builder,MedicalAlternative>

    • builder

      public static MedicalAlternative.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • 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