Class MedicalScribeSessionControlEvent
- java.lang.Object
-
- software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeSessionControlEvent
-
- All Implemented Interfaces:
Serializable,SdkPojo,MedicalScribeInputStream,ToCopyableBuilder<MedicalScribeSessionControlEvent.Builder,MedicalScribeSessionControlEvent>
- Direct Known Subclasses:
DefaultSessionControlEvent
@Generated("software.amazon.awssdk:codegen") public class MedicalScribeSessionControlEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MedicalScribeSessionControlEvent.Builder,MedicalScribeSessionControlEvent>, MedicalScribeInputStream
Specify the lifecycle of your streaming session.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceMedicalScribeSessionControlEvent.Builderprotected static classMedicalScribeSessionControlEvent.BuilderImpl-
Nested classes/interfaces inherited from interface software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeInputStream
MedicalScribeInputStream.EventType
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedMedicalScribeSessionControlEvent(MedicalScribeSessionControlEvent.BuilderImpl builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MedicalScribeSessionControlEvent.Builderbuilder()MedicalScribeSessionControlEventcopy(Consumer<? super MedicalScribeSessionControlEvent.Builder> modifier)booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends MedicalScribeSessionControlEvent.Builder>serializableBuilderClass()MedicalScribeSessionControlEvent.BuildertoBuilder()StringtoString()Returns a string representation of this object.MedicalScribeSessionControlEventTypetype()The type ofMedicalScribeSessionControlEvent.StringtypeAsString()The type ofMedicalScribeSessionControlEvent.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeInputStream
sdkEventType
-
-
-
-
Constructor Detail
-
MedicalScribeSessionControlEvent
protected MedicalScribeSessionControlEvent(MedicalScribeSessionControlEvent.BuilderImpl builder)
-
-
Method Detail
-
type
public final MedicalScribeSessionControlEventType type()
The type of
MedicalScribeSessionControlEvent.Possible Values:
-
END_OF_SESSION- Indicates the audio streaming is complete. After you send an END_OF_SESSION event, Amazon Web Services HealthScribe starts the post-stream analytics. The session can't be resumed after this event is sent. After Amazon Web Services HealthScribe processes the event, the real-timeStreamStatusisCOMPLETED. You get theStreamStatusand other stream details with the GetMedicalScribeStream API operation. For more information about different streaming statuses, see theStreamStatusdescription in the MedicalScribeStreamDetails.
If the service returns an enum value that is not available in the current SDK version,
typewill returnMedicalScribeSessionControlEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of
MedicalScribeSessionControlEvent.Possible Values:
-
END_OF_SESSION- Indicates the audio streaming is complete. After you send an END_OF_SESSION event, Amazon Web Services HealthScribe starts the post-stream analytics. The session can't be resumed after this event is sent. After Amazon Web Services HealthScribe processes the event, the real-timeStreamStatusisCOMPLETED. You get theStreamStatusand other stream details with the GetMedicalScribeStream API operation. For more information about different streaming statuses, see theStreamStatusdescription in the MedicalScribeStreamDetails.
-
- See Also:
MedicalScribeSessionControlEventType
-
-
typeAsString
public final String typeAsString()
The type of
MedicalScribeSessionControlEvent.Possible Values:
-
END_OF_SESSION- Indicates the audio streaming is complete. After you send an END_OF_SESSION event, Amazon Web Services HealthScribe starts the post-stream analytics. The session can't be resumed after this event is sent. After Amazon Web Services HealthScribe processes the event, the real-timeStreamStatusisCOMPLETED. You get theStreamStatusand other stream details with the GetMedicalScribeStream API operation. For more information about different streaming statuses, see theStreamStatusdescription in the MedicalScribeStreamDetails.
If the service returns an enum value that is not available in the current SDK version,
typewill returnMedicalScribeSessionControlEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of
MedicalScribeSessionControlEvent.Possible Values:
-
END_OF_SESSION- Indicates the audio streaming is complete. After you send an END_OF_SESSION event, Amazon Web Services HealthScribe starts the post-stream analytics. The session can't be resumed after this event is sent. After Amazon Web Services HealthScribe processes the event, the real-timeStreamStatusisCOMPLETED. You get theStreamStatusand other stream details with the GetMedicalScribeStream API operation. For more information about different streaming statuses, see theStreamStatusdescription in the MedicalScribeStreamDetails.
-
- See Also:
MedicalScribeSessionControlEventType
-
-
toBuilder
public MedicalScribeSessionControlEvent.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<MedicalScribeSessionControlEvent.Builder,MedicalScribeSessionControlEvent>
-
builder
public static MedicalScribeSessionControlEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends MedicalScribeSessionControlEvent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
copy
public final MedicalScribeSessionControlEvent copy(Consumer<? super MedicalScribeSessionControlEvent.Builder> modifier)
- Specified by:
copyin interfaceToCopyableBuilder<MedicalScribeSessionControlEvent.Builder,MedicalScribeSessionControlEvent>
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-