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:

  • 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:

    • 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:

    • toBuilder

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

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

    • copy

      public final MedicalScribeSessionControlEvent copy(Consumer<? super MedicalScribeSessionControlEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<MedicalScribeSessionControlEvent.Builder,MedicalScribeSessionControlEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

    • 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.