Class StartSpeechSynthesisStreamRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.polly.model.PollyRequest
software.amazon.awssdk.services.polly.model.StartSpeechSynthesisStreamRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartSpeechSynthesisStreamRequest.Builder,StartSpeechSynthesisStreamRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartSpeechSynthesisStreamRequest extends PollyRequest implements ToCopyableBuilder<StartSpeechSynthesisStreamRequest.Builder,StartSpeechSynthesisStreamRequest>

  • Method Details

    • engine

      public final Engine engine()

      Specifies the engine for Amazon Polly to use when processing input text for speech synthesis. Currently, only the generative engine is supported. If you specify a voice that the selected engine doesn't support, Amazon Polly returns an error.

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

      Returns:
      Specifies the engine for Amazon Polly to use when processing input text for speech synthesis. Currently, only the generative engine is supported. If you specify a voice that the selected engine doesn't support, Amazon Polly returns an error.
      See Also:

    • engineAsString

      public final String engineAsString()

      Specifies the engine for Amazon Polly to use when processing input text for speech synthesis. Currently, only the generative engine is supported. If you specify a voice that the selected engine doesn't support, Amazon Polly returns an error.

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

      Returns:
      Specifies the engine for Amazon Polly to use when processing input text for speech synthesis. Currently, only the generative engine is supported. If you specify a voice that the selected engine doesn't support, Amazon Polly returns an error.
      See Also:

    • languageCode

      public final LanguageCode languageCode()

      An optional parameter that sets the language code for the speech synthesis request. Specify this parameter only when using a bilingual voice. If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice.

      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:
      An optional parameter that sets the language code for the speech synthesis request. Specify this parameter only when using a bilingual voice. If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      An optional parameter that sets the language code for the speech synthesis request. Specify this parameter only when using a bilingual voice. If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice.

      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:
      An optional parameter that sets the language code for the speech synthesis request. Specify this parameter only when using a bilingual voice. If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice.
      See Also:

    • hasLexiconNames

      public final boolean hasLexiconNames()
      For responses, this returns true if the service returned a value for the LexiconNames 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.

    • lexiconNames

      public final List<String> lexiconNames()

      The names of one or more pronunciation lexicons for the service to apply during synthesis. Amazon Polly applies lexicons only when the lexicon language matches the voice language.

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

      Returns:
      The names of one or more pronunciation lexicons for the service to apply during synthesis. Amazon Polly applies lexicons only when the lexicon language matches the voice language.

    • outputFormat

      public final OutputFormat outputFormat()

      The audio format for the synthesized speech. Currently, Amazon Polly does not support JSON speech marks.

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

      Returns:
      The audio format for the synthesized speech. Currently, Amazon Polly does not support JSON speech marks.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The audio format for the synthesized speech. Currently, Amazon Polly does not support JSON speech marks.

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

      Returns:
      The audio format for the synthesized speech. Currently, Amazon Polly does not support JSON speech marks.
      See Also:

    • sampleRate

      public final String sampleRate()

      The audio frequency, specified in Hz.

      Returns:
      The audio frequency, specified in Hz.

    • voiceId

      public final VoiceId voiceId()

      The voice to use in synthesis. To get a list of available voice IDs, use the DescribeVoices operation.

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

      Returns:
      The voice to use in synthesis. To get a list of available voice IDs, use the DescribeVoices operation.
      See Also:

    • voiceIdAsString

      public final String voiceIdAsString()

      The voice to use in synthesis. To get a list of available voice IDs, use the DescribeVoices operation.

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

      Returns:
      The voice to use in synthesis. To get a list of available voice IDs, use the DescribeVoices operation.
      See Also:

    • toBuilder

      public StartSpeechSynthesisStreamRequest.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<StartSpeechSynthesisStreamRequest.Builder,StartSpeechSynthesisStreamRequest>
      Specified by:
      toBuilder in class PollyRequest
      Returns:
      a builder for type T

    • builder

      public static StartSpeechSynthesisStreamRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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: 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 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.