Class MedicalScribeStreamDetails

java.lang.Object
software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeStreamDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MedicalScribeStreamDetails.Builder,MedicalScribeStreamDetails>

@Generated("software.amazon.awssdk:codegen") public final class MedicalScribeStreamDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MedicalScribeStreamDetails.Builder,MedicalScribeStreamDetails>

Contains details about a Amazon Web Services HealthScribe streaming session.

See Also:
  • Method Details

    • sessionId

      public final String sessionId()

      The identifier of the HealthScribe streaming session.

      Returns:
      The identifier of the HealthScribe streaming session.
    • streamCreatedAt

      public final Instant streamCreatedAt()

      The date and time when the HealthScribe streaming session was created.

      Returns:
      The date and time when the HealthScribe streaming session was created.
    • streamEndedAt

      public final Instant streamEndedAt()

      The date and time when the HealthScribe streaming session was ended.

      Returns:
      The date and time when the HealthScribe streaming session was ended.
    • languageCode

      public final MedicalScribeLanguageCode languageCode()

      The Language Code of the 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:
      The Language Code of the HealthScribe streaming session.
      See Also:
    • languageCodeAsString

      public final String languageCodeAsString()

      The Language Code of the 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:
      The Language Code of the HealthScribe streaming session.
      See Also:
    • mediaSampleRateHertz

      public final Integer mediaSampleRateHertz()

      The sample rate (in hertz) of the HealthScribe streaming session.

      Returns:
      The sample rate (in hertz) of the HealthScribe streaming session.
    • mediaEncoding

      public final MedicalScribeMediaEncoding mediaEncoding()

      The Media Encoding of the HealthScribe streaming session.

      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 of the HealthScribe streaming session.
      See Also:
    • mediaEncodingAsString

      public final String mediaEncodingAsString()

      The Media Encoding of the HealthScribe streaming session.

      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 of the HealthScribe streaming session.
      See Also:
    • vocabularyName

      public final String vocabularyName()

      The vocabulary name of the HealthScribe streaming session.

      Returns:
      The vocabulary name of the HealthScribe streaming session.
    • vocabularyFilterName

      public final String vocabularyFilterName()

      The name of the vocabulary filter used for the HealthScribe streaming session .

      Returns:
      The name of the vocabulary filter used for the HealthScribe streaming session .
    • vocabularyFilterMethod

      public final MedicalScribeVocabularyFilterMethod vocabularyFilterMethod()

      The method of the vocabulary filter for the HealthScribe streaming session.

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

      Returns:
      The method of the vocabulary filter for the HealthScribe streaming session.
      See Also:
    • vocabularyFilterMethodAsString

      public final String vocabularyFilterMethodAsString()

      The method of the vocabulary filter for the HealthScribe streaming session.

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

      Returns:
      The method of the vocabulary filter for the HealthScribe streaming session.
      See Also:
    • resourceAccessRoleArn

      public final String resourceAccessRoleArn()

      The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.

      Returns:
      The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.
    • hasChannelDefinitions

      public final boolean hasChannelDefinitions()
      For responses, this returns true if the service returned a value for the ChannelDefinitions 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.
    • channelDefinitions

      public final List<MedicalScribeChannelDefinition> channelDefinitions()

      The Channel Definitions of the HealthScribe streaming session.

      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 hasChannelDefinitions() method.

      Returns:
      The Channel Definitions of the HealthScribe streaming session.
    • encryptionSettings

      public final MedicalScribeEncryptionSettings encryptionSettings()

      The Encryption Settings of the HealthScribe streaming session.

      Returns:
      The Encryption Settings of the HealthScribe streaming session.
    • streamStatus

      public final MedicalScribeStreamStatus streamStatus()

      The streaming status of the HealthScribe streaming session.

      Possible Values:

      • IN_PROGRESS

      • PAUSED

      • FAILED

      • COMPLETED

      This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

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

      Returns:
      The streaming status of the HealthScribe streaming session.

      Possible Values:

      • IN_PROGRESS

      • PAUSED

      • FAILED

      • COMPLETED

      This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

      See Also:
    • streamStatusAsString

      public final String streamStatusAsString()

      The streaming status of the HealthScribe streaming session.

      Possible Values:

      • IN_PROGRESS

      • PAUSED

      • FAILED

      • COMPLETED

      This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

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

      Returns:
      The streaming status of the HealthScribe streaming session.

      Possible Values:

      • IN_PROGRESS

      • PAUSED

      • FAILED

      • COMPLETED

      This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

      See Also:
    • postStreamAnalyticsSettings

      public final MedicalScribePostStreamAnalyticsSettings postStreamAnalyticsSettings()

      The post-stream analytics settings of the HealthScribe streaming session.

      Returns:
      The post-stream analytics settings of the HealthScribe streaming session.
    • postStreamAnalyticsResult

      public final MedicalScribePostStreamAnalyticsResult postStreamAnalyticsResult()

      The result of post-stream analytics for the HealthScribe streaming session.

      Returns:
      The result of post-stream analytics for the HealthScribe streaming session.
    • 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<MedicalScribeStreamDetails.Builder,MedicalScribeStreamDetails>
      Returns:
      a builder for type T
    • builder

      public static MedicalScribeStreamDetails.Builder builder()
    • serializableBuilderClass

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