software.amazon.awssdk.services.transcribestreaming.model

Class StartStreamTranscriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transcribestreaming.model.TranscribeStreamingRequest

software.amazon.awssdk.services.transcribestreaming.model.StartStreamTranscriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartStreamTranscriptionRequest.Builder,StartStreamTranscriptionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartStreamTranscriptionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartStreamTranscriptionRequest.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 SdkRequest.
int	hashCode()
LanguageCode	languageCode() Indicates the language used in the input audio stream.
String	languageCodeAsString() Indicates the language used in the input audio stream.
MediaEncoding	mediaEncoding() The encoding used for the input audio.
String	mediaEncodingAsString() The encoding used for the input audio.
Integer	mediaSampleRateHertz() The sample rate, in Hertz, of the input audio.
List<SdkField<?>>	sdkFields()
static Class<? extends StartStreamTranscriptionRequest.Builder>	serializableBuilderClass()
String	sessionId() A identifier for the transcription session.
StartStreamTranscriptionRequest.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 to use when processing the transcription job.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

languageCode

public LanguageCode languageCode()

Indicates the language used in 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:

Indicates the language used in the input audio stream.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

Indicates the language used in 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:

Indicates the language used in the input audio stream.

See Also:

LanguageCode

mediaSampleRateHertz

public Integer mediaSampleRateHertz()

The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low quality audio and 16000 Hz for high quality audio.

Returns:

The sample rate, in Hertz, of the input audio. We suggest that you 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.

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.

See Also:

MediaEncoding

mediaEncodingAsString

public String mediaEncodingAsString()

The encoding used for the input audio.

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.

See Also:

MediaEncoding

vocabularyName

public String vocabularyName()

The name of the vocabulary to use when processing the transcription job.

Returns:

The name of the vocabulary to use when processing the transcription job.

sessionId

public String sessionId()

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Returns:

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

toBuilder

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

Specified by:

toBuilder in class TranscribeStreamingRequest

Returns:

a builder for type T

builder

public static StartStreamTranscriptionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartStreamTranscriptionRequest.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: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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.