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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClinicalNoteGenerationResult.Builder

Method Summary

Modifier and Type	Method	Description
static ClinicalNoteGenerationResult.Builder	builder()
String	clinicalNoteOutputLocation()	Holds the Amazon S3 URI for the output Clinical Note.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	If ClinicalNoteGenerationResult is FAILED, information about why it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ClinicalNoteGenerationResult.Builder>	serializableBuilderClass()
ClinicalNoteGenerationStatus	status()	The status of the clinical note generation.
String	statusAsString()	The status of the clinical note generation.
ClinicalNoteGenerationResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	transcriptOutputLocation()	Holds the Amazon S3 URI for the output Transcript.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ClinicalNoteGenerationStatus

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:

ClinicalNoteGenerationStatus

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

Specified by:

toBuilder in interface ToCopyableBuilder<ClinicalNoteGenerationResult.Builder,ClinicalNoteGenerationResult>

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)

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