Class DescribeVoicesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeVoicesRequest.Builder,
DescribeVoicesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Engine
engine()
Specifies the engine (standard
,neural
orlong-form
) used by Amazon Polly when processing input text for speech synthesis.final String
Specifies the engine (standard
,neural
orlong-form
) used by Amazon Polly when processing input text for speech synthesis.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Boolean
Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.final LanguageCode
The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.final String
The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.final String
An opaque pagination token returned from the previousDescribeVoices
operation.static Class
<? extends DescribeVoicesRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
engine
Specifies the engine (
standard
,neural
orlong-form
) 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 returnEngine.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromengineAsString()
.- Returns:
- Specifies the engine (
standard
,neural
orlong-form
) used by Amazon Polly when processing input text for speech synthesis. - See Also:
-
engineAsString
Specifies the engine (
standard
,neural
orlong-form
) 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 returnEngine.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromengineAsString()
.- Returns:
- Specifies the engine (
standard
,neural
orlong-form
) used by Amazon Polly when processing input text for speech synthesis. - See Also:
-
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 returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- 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
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 returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- 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
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 specifyno
.- 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 specifyno
.
-
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
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 interfaceToCopyableBuilder<DescribeVoicesRequest.Builder,
DescribeVoicesRequest> - Specified by:
toBuilder
in classPollyRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-