software.amazon.awssdk.services.transcribestreaming.model

Class Alternative

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.Alternative

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Alternative.Builder

Method Summary

Modifier and Type	Method and Description
static Alternative.Builder	builder()
List<Entity>	entities() Contains entities identified as personally identifiable information (PII) in your transcription output.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEntities() For responses, this returns true if the service returned a value for the Entities property.
int	hashCode()
boolean	hasItems() For responses, this returns true if the service returned a value for the Items property.
List<Item>	items() Contains words, phrases, or punctuation marks in your transcription output.
List<SdkField<?>>	sdkFields()
static Class<? extends Alternative.Builder>	serializableBuilderClass()
Alternative.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	transcript() Contains transcribed text.

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

transcript

public final String transcript()

Contains transcribed text.

Returns:

Contains transcribed text.

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

Contains words, phrases, or punctuation marks in your transcription output.

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 transcription output.

hasEntities

public final boolean hasEntities()

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

entities

public final List<Entity> entities()

Contains entities identified as personally identifiable information (PII) in your transcription output.

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

Returns:

Contains entities identified as personally identifiable information (PII) in your transcription output.

toBuilder

public Alternative.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Alternative.Builder,Alternative>

builder

public static Alternative.Builder builder()

serializableBuilderClass

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