Class MedicalScribeTranscriptSegment

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

Contains a set of transcription results, along with additional information of the segment.

See Also:

  • Method Details

    • segmentId

      public final String segmentId()

      The identifier of the segment.

      Returns:
      The identifier of the segment.

    • beginAudioTime

      public final Double beginAudioTime()

      The start time, in milliseconds, of the segment.

      Returns:
      The start time, in milliseconds, of the segment.

    • endAudioTime

      public final Double endAudioTime()

      The end time, in milliseconds, of the segment.

      Returns:
      The end time, in milliseconds, of the segment.

    • content

      public final String content()

      Contains transcribed text of the segment.

      Returns:
      Contains transcribed text of the segment.

    • hasItems

      public final boolean hasItems()
      For responses, this returns true if the service returned a value for the Items property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • items

      public final List<MedicalScribeTranscriptItem> items()

      Contains words, phrases, or punctuation marks in your segment.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItems() method.

      Returns:
      Contains words, phrases, or punctuation marks in your segment.

    • isPartial

      public final Boolean isPartial()

      Indicates if the segment is complete.

      If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.

      Returns:
      Indicates if the segment is complete.

      If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.

    • channelId

      public final String channelId()

      Indicates which audio channel is associated with the MedicalScribeTranscriptSegment.

      If MedicalScribeChannelDefinition is not provided in the MedicalScribeConfigurationEvent, then this field will not be included.

      Returns:
      Indicates which audio channel is associated with the MedicalScribeTranscriptSegment.

      If MedicalScribeChannelDefinition is not provided in the MedicalScribeConfigurationEvent, then this field will not be included.

    • toBuilder

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

    • builder

      public static MedicalScribeTranscriptSegment.Builder builder()

    • serializableBuilderClass

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