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

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 interface	MedicalScribeSessionControlEvent.Builder
protected static class	MedicalScribeSessionControlEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeInputStream

MedicalScribeInputStream.EventType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MedicalScribeSessionControlEvent(MedicalScribeSessionControlEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
static MedicalScribeSessionControlEvent.Builder	builder()
final MedicalScribeSessionControlEvent	copy(Consumer<? super MedicalScribeSessionControlEvent.Builder> modifier)
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends MedicalScribeSessionControlEvent.Builder>	serializableBuilderClass()
MedicalScribeSessionControlEvent.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final MedicalScribeSessionControlEventType	type()	The type of MedicalScribeSessionControlEvent.
final String	typeAsString()	The type of MedicalScribeSessionControlEvent.

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 Details

MedicalScribeSessionControlEvent

protected MedicalScribeSessionControlEvent(MedicalScribeSessionControlEvent.BuilderImpl builder)

Method Details

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-time StreamStatus is COMPLETED. You get the StreamStatus and other stream details with the GetMedicalScribeStream API operation. For more information about different streaming statuses, see the StreamStatus description in the MedicalScribeStreamDetails.

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

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-time StreamStatus is COMPLETED. You get the StreamStatus and other stream details with the GetMedicalScribeStream API operation. For more information about different streaming statuses, see the StreamStatus description 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-time StreamStatus is COMPLETED. You get the StreamStatus and other stream details with the GetMedicalScribeStream API operation. For more information about different streaming statuses, see the StreamStatus description in the MedicalScribeStreamDetails.

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

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-time StreamStatus is COMPLETED. You get the StreamStatus and other stream details with the GetMedicalScribeStream API operation. For more information about different streaming statuses, see the StreamStatus description in the MedicalScribeStreamDetails.

See Also:

• MedicalScribeSessionControlEventType

toBuilder

public MedicalScribeSessionControlEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalScribeSessionControlEvent.Builder,MedicalScribeSessionControlEvent>

builder

public static MedicalScribeSessionControlEvent.Builder builder()

serializableBuilderClass

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

copy

public final MedicalScribeSessionControlEvent copy(Consumer<? super MedicalScribeSessionControlEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<MedicalScribeSessionControlEvent.Builder,MedicalScribeSessionControlEvent>

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