Class StartMedicalScribeStreamResponse

  • Method Details

    • sessionId

      public final String sessionId()

      The identifier (in UUID format) for your streaming session.

      If you already started streaming, this is same ID as the one you specified in your initial StartMedicalScribeStreamRequest.

      Returns:
      The identifier (in UUID format) for your streaming session.

      If you already started streaming, this is same ID as the one you specified in your initial StartMedicalScribeStreamRequest.

    • requestId

      public final String requestId()

      The unique identifier for your streaming request.

      Returns:
      The unique identifier for your streaming request.
    • languageCode

      public final MedicalScribeLanguageCode languageCode()

      The Language Code that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest.

      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:
      The Language Code that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest.
      See Also:
    • languageCodeAsString

      public final String languageCodeAsString()

      The Language Code that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest.

      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:
      The Language Code that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest.
      See Also:
    • mediaSampleRateHertz

      public final Integer mediaSampleRateHertz()

      The sample rate (in hertz) that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest

      Returns:
      The sample rate (in hertz) that you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
    • mediaEncoding

      public final MedicalScribeMediaEncoding mediaEncoding()

      The Media Encoding you specified in your request. Same as provided in the StartMedicalScribeStreamRequest

      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:
      The Media Encoding you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
      See Also:
    • mediaEncodingAsString

      public final String mediaEncodingAsString()

      The Media Encoding you specified in your request. Same as provided in the StartMedicalScribeStreamRequest

      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:
      The Media Encoding you specified in your request. Same as provided in the StartMedicalScribeStreamRequest
      See Also:
    • 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<StartMedicalScribeStreamResponse.Builder,StartMedicalScribeStreamResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends StartMedicalScribeStreamResponse.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.
    • sdkFieldNameToField

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