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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MedicalScribeTranscriptSegment.Builder

Method Summary

Modifier and Type	Method	Description
Double	beginAudioTime()	The start time, in milliseconds, of the segment.
static MedicalScribeTranscriptSegment.Builder	builder()
String	channelId()	Indicates which audio channel is associated with the MedicalScribeTranscriptSegment.
String	content()	Contains transcribed text of the segment.
Double	endAudioTime()	The end time, in milliseconds, of the segment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItems()	For responses, this returns true if the service returned a value for the Items property.
Boolean	isPartial()	Indicates if the segment is complete.
List<MedicalScribeTranscriptItem>	items()	Contains words, phrases, or punctuation marks in your segment.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	segmentId()	The identifier of the segment.
static Class<? extends MedicalScribeTranscriptSegment.Builder>	serializableBuilderClass()
MedicalScribeTranscriptSegment.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalScribeTranscriptSegment.Builder,MedicalScribeTranscriptSegment>

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)

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