Class DescribeVoicesRequest

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.DescribeVoicesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeVoicesRequest.Builder,DescribeVoicesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeVoicesRequest extends PollyRequest implements ToCopyableBuilder<DescribeVoicesRequest.Builder,DescribeVoicesRequest>

  • Method Details

    • engine

      public final Engine engine()

      Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.

      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 (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.
      See Also:

    • engineAsString

      public final String engineAsString()

      Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.

      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 (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.
      See Also:

    • languageCode

      public final LanguageCode languageCode()

      The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

      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 identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

      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 identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.
      See Also:

    • includeAdditionalLanguageCodes

      public final Boolean includeAdditionalLanguageCodes()

      Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

      Returns:
      Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

    • nextToken

      public final String nextToken()

      An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

      Returns:
      An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

    • toBuilder

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

    • builder

      public static DescribeVoicesRequest.Builder builder()

    • serializableBuilderClass

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