Class ClinicalNoteGenerationResult

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

The details for clinical note generation, including status, and output locations for clinical note and aggregated transcript if the analytics completed, or failure reason if the analytics failed.

See Also:

  • Method Details

    • clinicalNoteOutputLocation

      public final String clinicalNoteOutputLocation()

      Holds the Amazon S3 URI for the output Clinical Note.

      Returns:
      Holds the Amazon S3 URI for the output Clinical Note.

    • transcriptOutputLocation

      public final String transcriptOutputLocation()

      Holds the Amazon S3 URI for the output Transcript.

      Returns:
      Holds the Amazon S3 URI for the output Transcript.

    • status

      public final ClinicalNoteGenerationStatus status()

      The status of the clinical note generation.

      Possible Values:

      • IN_PROGRESS

      • FAILED

      • COMPLETED

      After audio streaming finishes, and you send a MedicalScribeSessionControlEvent event (with END_OF_SESSION as the Type), the status is set to IN_PROGRESS. If the status is COMPLETED, the analytics completed successfully, and you can find the results at the locations specified in ClinicalNoteOutputLocation and TranscriptOutputLocation. If the status is FAILED, FailureReason provides details about the failure.

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

      Returns:
      The status of the clinical note generation.

      Possible Values:

      • IN_PROGRESS

      • FAILED

      • COMPLETED

      After audio streaming finishes, and you send a MedicalScribeSessionControlEvent event (with END_OF_SESSION as the Type), the status is set to IN_PROGRESS. If the status is COMPLETED, the analytics completed successfully, and you can find the results at the locations specified in ClinicalNoteOutputLocation and TranscriptOutputLocation. If the status is FAILED, FailureReason provides details about the failure.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the clinical note generation.

      Possible Values:

      • IN_PROGRESS

      • FAILED

      • COMPLETED

      After audio streaming finishes, and you send a MedicalScribeSessionControlEvent event (with END_OF_SESSION as the Type), the status is set to IN_PROGRESS. If the status is COMPLETED, the analytics completed successfully, and you can find the results at the locations specified in ClinicalNoteOutputLocation and TranscriptOutputLocation. If the status is FAILED, FailureReason provides details about the failure.

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

      Returns:
      The status of the clinical note generation.

      Possible Values:

      • IN_PROGRESS

      • FAILED

      • COMPLETED

      After audio streaming finishes, and you send a MedicalScribeSessionControlEvent event (with END_OF_SESSION as the Type), the status is set to IN_PROGRESS. If the status is COMPLETED, the analytics completed successfully, and you can find the results at the locations specified in ClinicalNoteOutputLocation and TranscriptOutputLocation. If the status is FAILED, FailureReason provides details about the failure.

      See Also:

    • failureReason

      public final String failureReason()

      If ClinicalNoteGenerationResult is FAILED, information about why it failed.

      Returns:
      If ClinicalNoteGenerationResult is FAILED, information about why it failed.

    • toBuilder

      public ClinicalNoteGenerationResult.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<ClinicalNoteGenerationResult.Builder,ClinicalNoteGenerationResult>
      Returns:
      a builder for type T

    • builder

      public static ClinicalNoteGenerationResult.Builder builder()

    • serializableBuilderClass

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