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

Class MedicalResult

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.MedicalResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MedicalResult.Builder,MedicalResult>

@Generated("software.amazon.awssdk:codegen")
public final class MedicalResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MedicalResult.Builder,MedicalResult>

The Result associated with a .

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MedicalResult.Builder

Method Summary

Modifier and Type	Method	Description
List<MedicalAlternative>	alternatives()	A list of possible alternative transcriptions for the input audio.
static MedicalResult.Builder	builder()
String	channelId()	Indicates the channel identified for the Result.
Double	endTime()	The end time, in seconds, of the Result.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlternatives()	For responses, this returns true if the service returned a value for the Alternatives property.
int	hashCode()
Boolean	isPartial()	Indicates if the segment is complete.
String	resultId()	Provides a unique identifier for the Result.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalResult.Builder>	serializableBuilderClass()
Double	startTime()	The start time, in seconds, of the Result.
MedicalResult.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

resultId

public final String resultId()

Provides a unique identifier for the Result.

Returns:

Provides a unique identifier for the Result.

startTime

public final Double startTime()

The start time, in seconds, of the Result.

Returns:

The start time, in seconds, of the Result.

endTime

public final Double endTime()

The end time, in seconds, of the Result.

Returns:

The end time, in seconds, of the Result.

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.

hasAlternatives

public final boolean hasAlternatives()

For responses, this returns true if the service returned a value for the Alternatives 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.

alternatives

public final List<MedicalAlternative> alternatives()

A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

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 hasAlternatives() method.

Returns:

A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

channelId

public final String channelId()

Indicates the channel identified for the Result.

Returns:

Indicates the channel identified for the Result.

toBuilder

public MedicalResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalResult.Builder,MedicalResult>

builder

public static MedicalResult.Builder builder()

serializableBuilderClass

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