Class StartMedicalScribeStreamRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.transcribestreaming.model.TranscribeStreamingRequest
software.amazon.awssdk.services.transcribestreaming.model.StartMedicalScribeStreamRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartMedicalScribeStreamRequest.Builder,StartMedicalScribeStreamRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartMedicalScribeStreamRequest extends TranscribeStreamingRequest implements ToCopyableBuilder<StartMedicalScribeStreamRequest.Builder,StartMedicalScribeStreamRequest>

  • Method Details

    • sessionId

      public final String sessionId()

      Specify an identifier for your streaming session (in UUID format). If you don't include a SessionId in your request, Amazon Web Services HealthScribe generates an ID and returns it in the response.

      Returns:
      Specify an identifier for your streaming session (in UUID format). If you don't include a SessionId in your request, Amazon Web Services HealthScribe generates an ID and returns it in the response.

    • languageCode

      public final MedicalScribeLanguageCode languageCode()

      Specify the language code for your HealthScribe streaming session.

      If the service returns an enum value that is not available in the current SDK version, languageCode will return MedicalScribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

      Returns:
      Specify the language code for your HealthScribe streaming session.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      Specify the language code for your HealthScribe streaming session.

      If the service returns an enum value that is not available in the current SDK version, languageCode will return MedicalScribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

      Returns:
      Specify the language code for your HealthScribe streaming session.
      See Also:

    • mediaSampleRateHertz

      public final Integer mediaSampleRateHertz()

      Specify the sample rate of the input audio (in hertz). Amazon Web Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you specify must match that of your audio.

      Returns:
      Specify the sample rate of the input audio (in hertz). Amazon Web Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you specify must match that of your audio.

    • mediaEncoding

      public final MedicalScribeMediaEncoding mediaEncoding()

      Specify the encoding used for the input audio.

      Supported formats are:

      • FLAC

      • OPUS-encoded audio in an Ogg container

      • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats.

      If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MedicalScribeMediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

      Returns:
      Specify the encoding used for the input audio.

      Supported formats are:

      • FLAC

      • OPUS-encoded audio in an Ogg container

      • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats.

      See Also:

    • mediaEncodingAsString

      public final String mediaEncodingAsString()

      Specify the encoding used for the input audio.

      Supported formats are:

      • FLAC

      • OPUS-encoded audio in an Ogg container

      • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats.

      If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MedicalScribeMediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

      Returns:
      Specify the encoding used for the input audio.

      Supported formats are:

      • FLAC

      • OPUS-encoded audio in an Ogg container

      • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats.

      See Also:

    • toBuilder

      public StartMedicalScribeStreamRequest.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<StartMedicalScribeStreamRequest.Builder,StartMedicalScribeStreamRequest>
      Specified by:
      toBuilder in class TranscribeStreamingRequest
      Returns:
      a builder for type T

    • builder

      public static StartMedicalScribeStreamRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.