software.amazon.awssdk.services.transcribestreaming.model

Class StartStreamTranscriptionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.transcribestreaming.model.TranscribeStreamingResponse

software.amazon.awssdk.services.transcribestreaming.model.StartStreamTranscriptionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartStreamTranscriptionResponse.Builder,StartStreamTranscriptionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartStreamTranscriptionResponse
extends TranscribeStreamingResponse
implements ToCopyableBuilder<StartStreamTranscriptionResponse.Builder,StartStreamTranscriptionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartStreamTranscriptionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static StartStreamTranscriptionResponse.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
LanguageCode	languageCode() The language code for the input audio stream.
String	languageCodeAsString() The language code for the input audio stream.
MediaEncoding	mediaEncoding() The encoding used for the input audio stream.
String	mediaEncodingAsString() The encoding used for the input audio stream.
Integer	mediaSampleRateHertz() The sample rate for the input audio stream.
String	requestId() An identifier for the streaming transcription.
List<SdkField<?>>	sdkFields()
static Class<? extends StartStreamTranscriptionResponse.Builder>	serializableBuilderClass()
String	sessionId() An identifier for a specific transcription session.
StartStreamTranscriptionResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	vocabularyName() The name of the vocabulary used when processing the job.

Methods inherited from class software.amazon.awssdk.services.transcribestreaming.model.TranscribeStreamingResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

requestId

public String requestId()

An identifier for the streaming transcription.

Returns:

An identifier for the streaming transcription.

languageCode

public LanguageCode languageCode()

The language code for the input audio stream.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code for the input audio stream.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

The language code for the input audio stream.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code for the input audio stream.

See Also:

LanguageCode

mediaSampleRateHertz

public Integer mediaSampleRateHertz()

The sample rate for the input audio stream. Use 8000 Hz for low quality audio and 16000 Hz for high quality audio.

Returns:

The sample rate for the input audio stream. Use 8000 Hz for low quality audio and 16000 Hz for high quality audio.

mediaEncoding

public MediaEncoding mediaEncoding()

The encoding used for the input audio stream.

If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

Returns:

The encoding used for the input audio stream.

See Also:

MediaEncoding

mediaEncodingAsString

public String mediaEncodingAsString()

The encoding used for the input audio stream.

If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

Returns:

The encoding used for the input audio stream.

See Also:

MediaEncoding

vocabularyName

public String vocabularyName()

The name of the vocabulary used when processing the job.

Returns:

The name of the vocabulary used when processing the job.

sessionId

public String sessionId()

An identifier for a specific transcription session.

Returns:

An identifier for a specific transcription session.

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static StartStreamTranscriptionResponse.Builder builder()

serializableBuilderClass

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

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.