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()
ContentIdentificationType	contentIdentificationType() Shows whether content identification was enabled in this stream.
String	contentIdentificationTypeAsString() Shows whether content identification was enabled in this stream.
ContentRedactionType	contentRedactionType() Shows whether content redaction was enabled in this stream.
String	contentRedactionTypeAsString() Shows whether content redaction was enabled in this stream.
Boolean	enableChannelIdentification() Shows whether channel identification was enabled in the stream.
Boolean	enablePartialResultsStabilization() Shows whether partial results stabilization was enabled in the transcription.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	identifyLanguage() The language code of the language identified in your media stream.
LanguageCode	languageCode() The language code of the input audio stream.
String	languageCodeAsString() The language code of the input audio stream.
String	languageModelName() The name of the custom language model used in the transcription.
String	languageOptions() The language codes used in the identification of your media stream's predominant language.
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, in Hertz (Hz), for the input audio stream.
Integer	numberOfChannels() The number of channels identified in the stream.
PartialResultsStability	partialResultsStability() If partial results stabilization has been enabled in the stream, shows the stability level.
String	partialResultsStabilityAsString() If partial results stabilization has been enabled in the stream, shows the stability level.
String	piiEntityTypes() Lists the PII entity types you specified in your request.
LanguageCode	preferredLanguage() The preferred language you specified in your request.
String	preferredLanguageAsString() The preferred language you specified in your request.
String	requestId() An identifier for the transcription.
List<SdkField<?>>	sdkFields()
static Class<? extends StartStreamTranscriptionResponse.Builder>	serializableBuilderClass()
String	sessionId() An identifier for a specific transcription session.
Boolean	showSpeakerLabel() Shows whether speaker identification was enabled in the transcription.
StartStreamTranscriptionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VocabularyFilterMethod	vocabularyFilterMethod() The vocabulary filtering method used when processing the stream.
String	vocabularyFilterMethodAsString() The vocabulary filtering method used when processing the stream.
String	vocabularyFilterName() The name of the vocabulary filter used when processing the stream.
String	vocabularyFilterNames() The name of the vocabulary filter used when processing the stream.
String	vocabularyName() The name of the custom vocabulary used when processing the stream.
String	vocabularyNames() The name of the custom vocabulary used when processing the stream.

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

requestId

public final String requestId()

An identifier for the transcription.

Returns:

An identifier for the transcription.

languageCode

public final LanguageCode languageCode()

The language code of 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 of the input audio stream.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code of 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 of the input audio stream.

See Also:

LanguageCode

mediaSampleRateHertz

public final Integer mediaSampleRateHertz()

The sample rate, in Hertz (Hz), for the input audio stream.

Returns:

The sample rate, in Hertz (Hz), for the input audio stream.

mediaEncoding

public final 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 final 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 final String vocabularyName()

The name of the custom vocabulary used when processing the stream.

Returns:

The name of the custom vocabulary used when processing the stream.

sessionId

public final String sessionId()

An identifier for a specific transcription session.

Returns:

An identifier for a specific transcription session.

vocabularyFilterName

public final String vocabularyFilterName()

The name of the vocabulary filter used when processing the stream.

Returns:

The name of the vocabulary filter used when processing the stream.

vocabularyFilterMethod

public final VocabularyFilterMethod vocabularyFilterMethod()

The vocabulary filtering method used when processing the stream.

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

Returns:

The vocabulary filtering method used when processing the stream.

See Also:

VocabularyFilterMethod

vocabularyFilterMethodAsString

public final String vocabularyFilterMethodAsString()

The vocabulary filtering method used when processing the stream.

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

Returns:

The vocabulary filtering method used when processing the stream.

See Also:

VocabularyFilterMethod

showSpeakerLabel

public final Boolean showSpeakerLabel()

Shows whether speaker identification was enabled in the transcription.

Returns:

Shows whether speaker identification was enabled in the transcription.

enableChannelIdentification

public final Boolean enableChannelIdentification()

Shows whether channel identification was enabled in the stream.

Returns:

Shows whether channel identification was enabled in the stream.

numberOfChannels

public final Integer numberOfChannels()

The number of channels identified in the stream.

Returns:

The number of channels identified in the stream.

enablePartialResultsStabilization

public final Boolean enablePartialResultsStabilization()

Shows whether partial results stabilization was enabled in the transcription.

Returns:

Shows whether partial results stabilization was enabled in the transcription.

partialResultsStability

public final PartialResultsStability partialResultsStability()

If partial results stabilization has been enabled in the stream, shows the stability level.

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

Returns:

If partial results stabilization has been enabled in the stream, shows the stability level.

See Also:

PartialResultsStability

partialResultsStabilityAsString

public final String partialResultsStabilityAsString()

If partial results stabilization has been enabled in the stream, shows the stability level.

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

Returns:

If partial results stabilization has been enabled in the stream, shows the stability level.

See Also:

PartialResultsStability

contentIdentificationType

public final ContentIdentificationType contentIdentificationType()

Shows whether content identification was enabled in this stream.

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

Returns:

Shows whether content identification was enabled in this stream.

See Also:

ContentIdentificationType

contentIdentificationTypeAsString

public final String contentIdentificationTypeAsString()

Shows whether content identification was enabled in this stream.

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

Returns:

Shows whether content identification was enabled in this stream.

See Also:

ContentIdentificationType

contentRedactionType

public final ContentRedactionType contentRedactionType()

Shows whether content redaction was enabled in this stream.

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

Returns:

Shows whether content redaction was enabled in this stream.

See Also:

ContentRedactionType

contentRedactionTypeAsString

public final String contentRedactionTypeAsString()

Shows whether content redaction was enabled in this stream.

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

Returns:

Shows whether content redaction was enabled in this stream.

See Also:

ContentRedactionType

piiEntityTypes

public final String piiEntityTypes()

Lists the PII entity types you specified in your request.

Returns:

Lists the PII entity types you specified in your request.

languageModelName

public final String languageModelName()

The name of the custom language model used in the transcription.

Returns:

The name of the custom language model used in the transcription.

identifyLanguage

public final Boolean identifyLanguage()

The language code of the language identified in your media stream.

Returns:

The language code of the language identified in your media stream.

languageOptions

public final String languageOptions()

The language codes used in the identification of your media stream's predominant language.

Returns:

The language codes used in the identification of your media stream's predominant language.

preferredLanguage

public final LanguageCode preferredLanguage()

The preferred language you specified in your request.

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

Returns:

The preferred language you specified in your request.

See Also:

LanguageCode

preferredLanguageAsString

public final String preferredLanguageAsString()

The preferred language you specified in your request.

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

Returns:

The preferred language you specified in your request.

See Also:

LanguageCode

vocabularyNames

public final String vocabularyNames()

The name of the custom vocabulary used when processing the stream.

Returns:

The name of the custom vocabulary used when processing the stream.

vocabularyFilterNames

public final String vocabularyFilterNames()

The name of the vocabulary filter used when processing the stream.

Returns:

The name of the vocabulary filter used when processing the stream.

toBuilder

public StartStreamTranscriptionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartStreamTranscriptionResponse.Builder,StartStreamTranscriptionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static StartStreamTranscriptionResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo