@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartSpeechSynthesisTaskRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
StartSpeechSynthesisTaskRequest() |
Modifier and Type | Method and Description |
---|---|
StartSpeechSynthesisTaskRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getEngine()
Specifies the engine (
standard , neural , long-form or
generative ) for Amazon Polly to use when processing input text for speech synthesis. |
String |
getLanguageCode()
Optional language code for the Speech Synthesis request.
|
List<String> |
getLexiconNames()
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
String |
getOutputFormat()
The format in which the returned output will be encoded.
|
String |
getOutputS3BucketName()
Amazon S3 bucket name to which the output file will be saved.
|
String |
getOutputS3KeyPrefix()
The Amazon S3 key prefix for the output speech file.
|
String |
getSampleRate()
The audio frequency specified in Hz.
|
String |
getSnsTopicArn()
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
|
List<String> |
getSpeechMarkTypes()
The type of speech marks returned for the input text.
|
String |
getText()
The input text to synthesize.
|
String |
getTextType()
Specifies whether the input text is plain text or SSML.
|
String |
getVoiceId()
Voice ID to use for the synthesis.
|
int |
hashCode() |
void |
setEngine(String engine)
Specifies the engine (
standard , neural , long-form or
generative ) for Amazon Polly to use when processing input text for speech synthesis. |
void |
setLanguageCode(String languageCode)
Optional language code for the Speech Synthesis request.
|
void |
setLexiconNames(Collection<String> lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
void |
setOutputFormat(String outputFormat)
The format in which the returned output will be encoded.
|
void |
setOutputS3BucketName(String outputS3BucketName)
Amazon S3 bucket name to which the output file will be saved.
|
void |
setOutputS3KeyPrefix(String outputS3KeyPrefix)
The Amazon S3 key prefix for the output speech file.
|
void |
setSampleRate(String sampleRate)
The audio frequency specified in Hz.
|
void |
setSnsTopicArn(String snsTopicArn)
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
|
void |
setSpeechMarkTypes(Collection<String> speechMarkTypes)
The type of speech marks returned for the input text.
|
void |
setText(String text)
The input text to synthesize.
|
void |
setTextType(String textType)
Specifies whether the input text is plain text or SSML.
|
void |
setVoiceId(String voiceId)
Voice ID to use for the synthesis.
|
String |
toString()
Returns a string representation of this object.
|
StartSpeechSynthesisTaskRequest |
withEngine(Engine engine)
Specifies the engine (
standard , neural , long-form or
generative ) for Amazon Polly to use when processing input text for speech synthesis. |
StartSpeechSynthesisTaskRequest |
withEngine(String engine)
Specifies the engine (
standard , neural , long-form or
generative ) for Amazon Polly to use when processing input text for speech synthesis. |
StartSpeechSynthesisTaskRequest |
withLanguageCode(LanguageCode languageCode)
Optional language code for the Speech Synthesis request.
|
StartSpeechSynthesisTaskRequest |
withLanguageCode(String languageCode)
Optional language code for the Speech Synthesis request.
|
StartSpeechSynthesisTaskRequest |
withLexiconNames(Collection<String> lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
StartSpeechSynthesisTaskRequest |
withLexiconNames(String... lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
StartSpeechSynthesisTaskRequest |
withOutputFormat(OutputFormat outputFormat)
The format in which the returned output will be encoded.
|
StartSpeechSynthesisTaskRequest |
withOutputFormat(String outputFormat)
The format in which the returned output will be encoded.
|
StartSpeechSynthesisTaskRequest |
withOutputS3BucketName(String outputS3BucketName)
Amazon S3 bucket name to which the output file will be saved.
|
StartSpeechSynthesisTaskRequest |
withOutputS3KeyPrefix(String outputS3KeyPrefix)
The Amazon S3 key prefix for the output speech file.
|
StartSpeechSynthesisTaskRequest |
withSampleRate(String sampleRate)
The audio frequency specified in Hz.
|
StartSpeechSynthesisTaskRequest |
withSnsTopicArn(String snsTopicArn)
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
|
StartSpeechSynthesisTaskRequest |
withSpeechMarkTypes(Collection<String> speechMarkTypes)
The type of speech marks returned for the input text.
|
StartSpeechSynthesisTaskRequest |
withSpeechMarkTypes(SpeechMarkType... speechMarkTypes)
The type of speech marks returned for the input text.
|
StartSpeechSynthesisTaskRequest |
withSpeechMarkTypes(String... speechMarkTypes)
The type of speech marks returned for the input text.
|
StartSpeechSynthesisTaskRequest |
withText(String text)
The input text to synthesize.
|
StartSpeechSynthesisTaskRequest |
withTextType(String textType)
Specifies whether the input text is plain text or SSML.
|
StartSpeechSynthesisTaskRequest |
withTextType(TextType textType)
Specifies whether the input text is plain text or SSML.
|
StartSpeechSynthesisTaskRequest |
withVoiceId(String voiceId)
Voice ID to use for the synthesis.
|
StartSpeechSynthesisTaskRequest |
withVoiceId(VoiceId voiceId)
Voice ID to use for the synthesis.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setEngine(String engine)
Specifies the engine (standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice
that is not supported for the engine selected will result in an error.
engine
- Specifies the engine (standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a
voice that is not supported for the engine selected will result in an error.Engine
public String getEngine()
Specifies the engine (standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice
that is not supported for the engine selected will result in an error.
standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a
voice that is not supported for the engine selected will result in an error.Engine
public StartSpeechSynthesisTaskRequest withEngine(String engine)
Specifies the engine (standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice
that is not supported for the engine selected will result in an error.
engine
- Specifies the engine (standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a
voice that is not supported for the engine selected will result in an error.Engine
public StartSpeechSynthesisTaskRequest withEngine(Engine engine)
Specifies the engine (standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice
that is not supported for the engine selected will result in an error.
engine
- Specifies the engine (standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for speech synthesis. Using a
voice that is not supported for the engine selected will result in an error.Engine
public void setLanguageCode(String languageCode)
Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the
bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the
LanguageCode
parameter. For example, if no language code is specified, Aditi will use Indian English
rather than Hindi.
languageCode
- Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual
voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of
the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation
for the LanguageCode
parameter. For example, if no language code is specified, Aditi will use
Indian English rather than Hindi.
LanguageCode
public String getLanguageCode()
Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the
bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the
LanguageCode
parameter. For example, if no language code is specified, Aditi will use Indian English
rather than Hindi.
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of
the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation
for the LanguageCode
parameter. For example, if no language code is specified, Aditi will
use Indian English rather than Hindi.
LanguageCode
public StartSpeechSynthesisTaskRequest withLanguageCode(String languageCode)
Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the
bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the
LanguageCode
parameter. For example, if no language code is specified, Aditi will use Indian English
rather than Hindi.
languageCode
- Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual
voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of
the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation
for the LanguageCode
parameter. For example, if no language code is specified, Aditi will use
Indian English rather than Hindi.
LanguageCode
public StartSpeechSynthesisTaskRequest withLanguageCode(LanguageCode languageCode)
Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the
bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the
LanguageCode
parameter. For example, if no language code is specified, Aditi will use Indian English
rather than Hindi.
languageCode
- Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual
voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of
the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation
for the LanguageCode
parameter. For example, if no language code is specified, Aditi will use
Indian English rather than Hindi.
LanguageCode
public List<String> getLexiconNames()
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
public void setLexiconNames(Collection<String> lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
lexiconNames
- List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons
are applied only if the language of the lexicon is the same as the language of the voice.public StartSpeechSynthesisTaskRequest withLexiconNames(String... lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
NOTE: This method appends the values to the existing list (if any). Use
setLexiconNames(java.util.Collection)
or withLexiconNames(java.util.Collection)
if you want to
override the existing values.
lexiconNames
- List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons
are applied only if the language of the lexicon is the same as the language of the voice.public StartSpeechSynthesisTaskRequest withLexiconNames(Collection<String> lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
lexiconNames
- List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons
are applied only if the language of the lexicon is the same as the language of the voice.public void setOutputFormat(String outputFormat)
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
outputFormat
- The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis,
or pcm. For speech marks, this will be json.OutputFormat
public String getOutputFormat()
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
OutputFormat
public StartSpeechSynthesisTaskRequest withOutputFormat(String outputFormat)
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
outputFormat
- The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis,
or pcm. For speech marks, this will be json.OutputFormat
public StartSpeechSynthesisTaskRequest withOutputFormat(OutputFormat outputFormat)
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
outputFormat
- The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis,
or pcm. For speech marks, this will be json.OutputFormat
public void setOutputS3BucketName(String outputS3BucketName)
Amazon S3 bucket name to which the output file will be saved.
outputS3BucketName
- Amazon S3 bucket name to which the output file will be saved.public String getOutputS3BucketName()
Amazon S3 bucket name to which the output file will be saved.
public StartSpeechSynthesisTaskRequest withOutputS3BucketName(String outputS3BucketName)
Amazon S3 bucket name to which the output file will be saved.
outputS3BucketName
- Amazon S3 bucket name to which the output file will be saved.public void setOutputS3KeyPrefix(String outputS3KeyPrefix)
The Amazon S3 key prefix for the output speech file.
outputS3KeyPrefix
- The Amazon S3 key prefix for the output speech file.public String getOutputS3KeyPrefix()
The Amazon S3 key prefix for the output speech file.
public StartSpeechSynthesisTaskRequest withOutputS3KeyPrefix(String outputS3KeyPrefix)
The Amazon S3 key prefix for the output speech file.
outputS3KeyPrefix
- The Amazon S3 key prefix for the output speech file.public void setSampleRate(String sampleRate)
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
sampleRate
- The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
public String getSampleRate()
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
public StartSpeechSynthesisTaskRequest withSampleRate(String sampleRate)
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
sampleRate
- The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
public void setSnsTopicArn(String snsTopicArn)
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
snsTopicArn
- ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.public String getSnsTopicArn()
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
public StartSpeechSynthesisTaskRequest withSnsTopicArn(String snsTopicArn)
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
snsTopicArn
- ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.public List<String> getSpeechMarkTypes()
The type of speech marks returned for the input text.
SpeechMarkType
public void setSpeechMarkTypes(Collection<String> speechMarkTypes)
The type of speech marks returned for the input text.
speechMarkTypes
- The type of speech marks returned for the input text.SpeechMarkType
public StartSpeechSynthesisTaskRequest withSpeechMarkTypes(String... speechMarkTypes)
The type of speech marks returned for the input text.
NOTE: This method appends the values to the existing list (if any). Use
setSpeechMarkTypes(java.util.Collection)
or withSpeechMarkTypes(java.util.Collection)
if you
want to override the existing values.
speechMarkTypes
- The type of speech marks returned for the input text.SpeechMarkType
public StartSpeechSynthesisTaskRequest withSpeechMarkTypes(Collection<String> speechMarkTypes)
The type of speech marks returned for the input text.
speechMarkTypes
- The type of speech marks returned for the input text.SpeechMarkType
public StartSpeechSynthesisTaskRequest withSpeechMarkTypes(SpeechMarkType... speechMarkTypes)
The type of speech marks returned for the input text.
speechMarkTypes
- The type of speech marks returned for the input text.SpeechMarkType
public void setText(String text)
The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
text
- The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input
text.public String getText()
The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
public StartSpeechSynthesisTaskRequest withText(String text)
The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
text
- The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input
text.public void setTextType(String textType)
Specifies whether the input text is plain text or SSML. The default value is plain text.
textType
- Specifies whether the input text is plain text or SSML. The default value is plain text.TextType
public String getTextType()
Specifies whether the input text is plain text or SSML. The default value is plain text.
TextType
public StartSpeechSynthesisTaskRequest withTextType(String textType)
Specifies whether the input text is plain text or SSML. The default value is plain text.
textType
- Specifies whether the input text is plain text or SSML. The default value is plain text.TextType
public StartSpeechSynthesisTaskRequest withTextType(TextType textType)
Specifies whether the input text is plain text or SSML. The default value is plain text.
textType
- Specifies whether the input text is plain text or SSML. The default value is plain text.TextType
public void setVoiceId(String voiceId)
Voice ID to use for the synthesis.
voiceId
- Voice ID to use for the synthesis.VoiceId
public String getVoiceId()
Voice ID to use for the synthesis.
VoiceId
public StartSpeechSynthesisTaskRequest withVoiceId(String voiceId)
Voice ID to use for the synthesis.
voiceId
- Voice ID to use for the synthesis.VoiceId
public StartSpeechSynthesisTaskRequest withVoiceId(VoiceId voiceId)
Voice ID to use for the synthesis.
voiceId
- Voice ID to use for the synthesis.VoiceId
public String toString()
toString
in class Object
Object.toString()
public StartSpeechSynthesisTaskRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()