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("software.amazon.awssdk:codegen") public final class StartStreamTranscriptionResponse extends TranscribeStreamingResponse implements ToCopyableBuilder<StartStreamTranscriptionResponse.Builder,StartStreamTranscriptionResponse>

  • Method Details

    • requestId

      public final String requestId()

      Provides the identifier for your streaming request.

      Returns:
      Provides the identifier for your streaming request.

    • languageCode

      public final LanguageCode languageCode()

      Provides the language code that you specified in your request.

      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:
      Provides the language code that you specified in your request.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      Provides the language code that you specified in your request.

      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:
      Provides the language code that you specified in your request.
      See Also:

    • mediaSampleRateHertz

      public final Integer mediaSampleRateHertz()

      Provides the sample rate that you specified in your request.

      Returns:
      Provides the sample rate that you specified in your request.

    • mediaEncoding

      public final MediaEncoding mediaEncoding()

      Provides the media encoding you specified in your request.

      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:
      Provides the media encoding you specified in your request.
      See Also:

    • mediaEncodingAsString

      public final String mediaEncodingAsString()

      Provides the media encoding you specified in your request.

      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:
      Provides the media encoding you specified in your request.
      See Also:

    • vocabularyName

      public final String vocabularyName()

      Provides the name of the custom vocabulary that you specified in your request.

      Returns:
      Provides the name of the custom vocabulary that you specified in your request.

    • sessionId

      public final String sessionId()

      Provides the identifier for your transcription session.

      Returns:
      Provides the identifier for your transcription session.

    • vocabularyFilterName

      public final String vocabularyFilterName()

      Provides the name of the custom vocabulary filter that you specified in your request.

      Returns:
      Provides the name of the custom vocabulary filter that you specified in your request.

    • vocabularyFilterMethod

      public final VocabularyFilterMethod vocabularyFilterMethod()

      Provides the vocabulary filtering method used in your transcription.

      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:
      Provides the vocabulary filtering method used in your transcription.
      See Also:

    • vocabularyFilterMethodAsString

      public final String vocabularyFilterMethodAsString()

      Provides the vocabulary filtering method used in your transcription.

      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:
      Provides the vocabulary filtering method used in your transcription.
      See Also:

    • showSpeakerLabel

      public final Boolean showSpeakerLabel()

      Shows whether speaker partitioning was enabled for your transcription.

      Returns:
      Shows whether speaker partitioning was enabled for your transcription.

    • enableChannelIdentification

      public final Boolean enableChannelIdentification()

      Shows whether channel identification was enabled for your transcription.

      Returns:
      Shows whether channel identification was enabled for your transcription.

    • numberOfChannels

      public final Integer numberOfChannels()

      Provides the number of channels that you specified in your request.

      Returns:
      Provides the number of channels that you specified in your request.

    • enablePartialResultsStabilization

      public final Boolean enablePartialResultsStabilization()

      Shows whether partial results stabilization was enabled for your transcription.

      Returns:
      Shows whether partial results stabilization was enabled for your transcription.

    • partialResultsStability

      public final PartialResultsStability partialResultsStability()

      Provides the stabilization level used for your transcription.

      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:
      Provides the stabilization level used for your transcription.
      See Also:

    • partialResultsStabilityAsString

      public final String partialResultsStabilityAsString()

      Provides the stabilization level used for your transcription.

      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:
      Provides the stabilization level used for your transcription.
      See Also:

    • contentIdentificationType

      public final ContentIdentificationType contentIdentificationType()

      Shows whether content identification was enabled for your transcription.

      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 for your transcription.
      See Also:

    • contentIdentificationTypeAsString

      public final String contentIdentificationTypeAsString()

      Shows whether content identification was enabled for your transcription.

      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 for your transcription.
      See Also:

    • contentRedactionType

      public final ContentRedactionType contentRedactionType()

      Shows whether content redaction was enabled for your transcription.

      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 for your transcription.
      See Also:

    • contentRedactionTypeAsString

      public final String contentRedactionTypeAsString()

      Shows whether content redaction was enabled for your transcription.

      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 for your transcription.
      See Also:

    • 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()

      Provides the name of the custom language model that you specified in your request.

      Returns:
      Provides the name of the custom language model that you specified in your request.

    • identifyLanguage

      public final Boolean identifyLanguage()

      Shows whether automatic language identification was enabled for your transcription.

      Returns:
      Shows whether automatic language identification was enabled for your transcription.

    • languageOptions

      public final String languageOptions()

      Provides the language codes that you specified in your request.

      Returns:
      Provides the language codes that you specified in your request.

    • preferredLanguage

      public final LanguageCode preferredLanguage()

      Provides the preferred language that 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:
      Provides the preferred language that you specified in your request.
      See Also:

    • preferredLanguageAsString

      public final String preferredLanguageAsString()

      Provides the preferred language that 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:
      Provides the preferred language that you specified in your request.
      See Also:

    • identifyMultipleLanguages

      public final Boolean identifyMultipleLanguages()

      Shows whether automatic multi-language identification was enabled for your transcription.

      Returns:
      Shows whether automatic multi-language identification was enabled for your transcription.

    • vocabularyNames

      public final String vocabularyNames()

      Provides the names of the custom vocabularies that you specified in your request.

      Returns:
      Provides the names of the custom vocabularies that you specified in your request.

    • vocabularyFilterNames

      public final String vocabularyFilterNames()

      Provides the names of the custom vocabulary filters that you specified in your request.

      Returns:
      Provides the names of the custom vocabulary filters that you specified in your request.

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.