software.amazon.awssdk.services.transcribestreaming.model

Class Result

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.Result

All Implemented Interfaces:

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

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

The result of transcribing a portion of the input audio stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Result.Builder

Method Summary

Modifier and Type	Method and Description
List<Alternative>	alternatives() A list of possible transcriptions for the audio.
static Result.Builder	builder()
Double	endTime() The offset in milliseconds from the beginning of the audio stream to the end of the result.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isPartial() true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the audio stream.
String	resultId() A unique identifier for the result.
List<SdkField<?>>	sdkFields()
static Class<? extends Result.Builder>	serializableBuilderClass()
Double	startTime() The offset in milliseconds from the beginning of the audio stream to the beginning of the result.
Result.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

resultId

public String resultId()

A unique identifier for the result.

Returns:

A unique identifier for the result.

startTime

public Double startTime()

The offset in milliseconds from the beginning of the audio stream to the beginning of the result.

Returns:

The offset in milliseconds from the beginning of the audio stream to the beginning of the result.

endTime

public Double endTime()

The offset in milliseconds from the beginning of the audio stream to the end of the result.

Returns:

The offset in milliseconds from the beginning of the audio stream to the end of the result.

isPartial

public Boolean isPartial()

true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the audio stream.

Returns:

true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the audio stream.

alternatives

public List<Alternative> alternatives()

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

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

Returns:

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

toBuilder

public Result.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<Result.Builder,Result>

Returns:

a builder for type T

builder

public static Result.Builder builder()

serializableBuilderClass

public static Class<? extends Result.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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