com.amazonaws.services.polly.model

Class StartSpeechSynthesisTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.polly.model.StartSpeechSynthesisTaskRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartSpeechSynthesisTaskRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartSpeechSynthesisTaskRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEngine() Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
java.lang.String	getLanguageCode() Optional language code for the Speech Synthesis request.
java.util.List<java.lang.String>	getLexiconNames() List of one or more pronunciation lexicon names you want the service to apply during synthesis.
java.lang.String	getOutputFormat() The format in which the returned output will be encoded.
java.lang.String	getOutputS3BucketName() Amazon S3 bucket name to which the output file will be saved.
java.lang.String	getOutputS3KeyPrefix() The Amazon S3 key prefix for the output speech file.
java.lang.String	getSampleRate() The audio frequency specified in Hz.
java.lang.String	getSnsTopicArn() ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
java.util.List<java.lang.String>	getSpeechMarkTypes() The type of speech marks returned for the input text.
java.lang.String	getText() The input text to synthesize.
java.lang.String	getTextType() Specifies whether the input text is plain text or SSML.
java.lang.String	getVoiceId() Voice ID to use for the synthesis.
int	hashCode()
void	setEngine(Engine engine) Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
void	setEngine(java.lang.String engine) Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
void	setLanguageCode(LanguageCode languageCode) Optional language code for the Speech Synthesis request.
void	setLanguageCode(java.lang.String languageCode) Optional language code for the Speech Synthesis request.
void	setLexiconNames(java.util.Collection<java.lang.String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
void	setOutputFormat(OutputFormat outputFormat) The format in which the returned output will be encoded.
void	setOutputFormat(java.lang.String outputFormat) The format in which the returned output will be encoded.
void	setOutputS3BucketName(java.lang.String outputS3BucketName) Amazon S3 bucket name to which the output file will be saved.
void	setOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix) The Amazon S3 key prefix for the output speech file.
void	setSampleRate(java.lang.String sampleRate) The audio frequency specified in Hz.
void	setSnsTopicArn(java.lang.String snsTopicArn) ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
void	setSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes) The type of speech marks returned for the input text.
void	setText(java.lang.String text) The input text to synthesize.
void	setTextType(java.lang.String textType) Specifies whether the input text is plain text or SSML.
void	setTextType(TextType textType) Specifies whether the input text is plain text or SSML.
void	setVoiceId(java.lang.String voiceId) Voice ID to use for the synthesis.
void	setVoiceId(VoiceId voiceId) Voice ID to use for the synthesis.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartSpeechSynthesisTaskRequest	withEngine(Engine engine) Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
StartSpeechSynthesisTaskRequest	withEngine(java.lang.String engine) Specifies the engine (standard or neural) 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(java.lang.String languageCode) Optional language code for the Speech Synthesis request.
StartSpeechSynthesisTaskRequest	withLexiconNames(java.util.Collection<java.lang.String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
StartSpeechSynthesisTaskRequest	withLexiconNames(java.lang.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(java.lang.String outputFormat) The format in which the returned output will be encoded.
StartSpeechSynthesisTaskRequest	withOutputS3BucketName(java.lang.String outputS3BucketName) Amazon S3 bucket name to which the output file will be saved.
StartSpeechSynthesisTaskRequest	withOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix) The Amazon S3 key prefix for the output speech file.
StartSpeechSynthesisTaskRequest	withSampleRate(java.lang.String sampleRate) The audio frequency specified in Hz.
StartSpeechSynthesisTaskRequest	withSnsTopicArn(java.lang.String snsTopicArn) ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
StartSpeechSynthesisTaskRequest	withSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes) The type of speech marks returned for the input text.
StartSpeechSynthesisTaskRequest	withSpeechMarkTypes(java.lang.String... speechMarkTypes) The type of speech marks returned for the input text.
StartSpeechSynthesisTaskRequest	withText(java.lang.String text) The input text to synthesize.
StartSpeechSynthesisTaskRequest	withTextType(java.lang.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(java.lang.String voiceId) Voice ID to use for the synthesis.
StartSpeechSynthesisTaskRequest	withVoiceId(VoiceId voiceId) Voice ID to use for the synthesis.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartSpeechSynthesisTaskRequest

public StartSpeechSynthesisTaskRequest()

Method Detail

getEngine

public java.lang.String getEngine()

Specifies the engine (standard or neural) 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.

Constraints:
Allowed Values: standard, neural

Returns:

Specifies the engine (standard or neural) 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.

See Also:

Engine

setEngine

public void setEngine(java.lang.String engine)

Specifies the engine (standard or neural) 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.

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

Specifies the engine (standard or neural) 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.

See Also:

Engine

withEngine

public StartSpeechSynthesisTaskRequest withEngine(java.lang.String engine)

Specifies the engine (standard or neural) 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

Specifies the engine (standard or neural) 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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Engine

setEngine

public void setEngine(Engine engine)

Specifies the engine (standard or neural) 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.

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

Specifies the engine (standard or neural) 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.

See Also:

Engine

withEngine

public StartSpeechSynthesisTaskRequest withEngine(Engine engine)

Specifies the engine (standard or neural) 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

Specifies the engine (standard or neural) 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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Engine

getLanguageCode

public java.lang.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 will use 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.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

Returns:

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 will use 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.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(java.lang.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 will use 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.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

Parameters:

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 will use 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.

See Also:

LanguageCode

withLanguageCode

public StartSpeechSynthesisTaskRequest withLanguageCode(java.lang.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 will use 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

Parameters:

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 will use 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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(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 will use 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.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

Parameters:

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 will use 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.

See Also:

LanguageCode

withLanguageCode

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 will use 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

Parameters:

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 will use 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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

getLexiconNames

public java.util.List<java.lang.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.

Returns:

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.

setLexiconNames

public void setLexiconNames(java.util.Collection<java.lang.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.

Parameters:

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.

withLexiconNames

public StartSpeechSynthesisTaskRequest withLexiconNames(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withLexiconNames

public StartSpeechSynthesisTaskRequest withLexiconNames(java.util.Collection<java.lang.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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getOutputFormat

public java.lang.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.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Returns:

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.

See Also:

OutputFormat

setOutputFormat

public void setOutputFormat(java.lang.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.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Parameters:

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.

See Also:

OutputFormat

withOutputFormat

public StartSpeechSynthesisTaskRequest withOutputFormat(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OutputFormat

setOutputFormat

public void setOutputFormat(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.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Parameters:

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.

See Also:

OutputFormat

withOutputFormat

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OutputFormat

getOutputS3BucketName

public java.lang.String getOutputS3BucketName()

Amazon S3 bucket name to which the output file will be saved.

Constraints:
Pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$

Returns:

Amazon S3 bucket name to which the output file will be saved.

setOutputS3BucketName

public void setOutputS3BucketName(java.lang.String outputS3BucketName)

Amazon S3 bucket name to which the output file will be saved.

Constraints:
Pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$

Parameters:

outputS3BucketName -

Amazon S3 bucket name to which the output file will be saved.

withOutputS3BucketName

public StartSpeechSynthesisTaskRequest withOutputS3BucketName(java.lang.String outputS3BucketName)

Amazon S3 bucket name to which the output file will be saved.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$

Parameters:

outputS3BucketName -

Amazon S3 bucket name to which the output file will be saved.

Returns:

A reference to this updated object so that method calls can be chained together.

getOutputS3KeyPrefix

public java.lang.String getOutputS3KeyPrefix()

The Amazon S3 key prefix for the output speech file.

Constraints:
Pattern: ^[0-9a-zA-Z\/\!\-_\.\*\'\(\):;\$@=+\,\?&]{0,800}$

Returns:

The Amazon S3 key prefix for the output speech file.

setOutputS3KeyPrefix

public void setOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix)

The Amazon S3 key prefix for the output speech file.

Constraints:
Pattern: ^[0-9a-zA-Z\/\!\-_\.\*\'\(\):;\$@=+\,\?&]{0,800}$

Parameters:

outputS3KeyPrefix -

The Amazon S3 key prefix for the output speech file.

withOutputS3KeyPrefix

public StartSpeechSynthesisTaskRequest withOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix)

The Amazon S3 key prefix for the output speech file.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ^[0-9a-zA-Z\/\!\-_\.\*\'\(\):;\$@=+\,\?&]{0,800}$

Parameters:

outputS3KeyPrefix -

The Amazon S3 key prefix for the output speech file.

Returns:

A reference to this updated object so that method calls can be chained together.

getSampleRate

public java.lang.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".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Returns:

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".

Valid values for pcm are "8000" and "16000" The default value is "16000".

setSampleRate

public void setSampleRate(java.lang.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".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Parameters:

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".

Valid values for pcm are "8000" and "16000" The default value is "16000".

withSampleRate

public StartSpeechSynthesisTaskRequest withSampleRate(java.lang.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".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Returns a reference to this object so that method calls can be chained together.

Parameters:

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".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Returns:

A reference to this updated object so that method calls can be chained together.

getSnsTopicArn

public java.lang.String getSnsTopicArn()

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Constraints:
Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0- 9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$

Returns:

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

setSnsTopicArn

public void setSnsTopicArn(java.lang.String snsTopicArn)

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Constraints:
Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0- 9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$

Parameters:

snsTopicArn -

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

withSnsTopicArn

public StartSpeechSynthesisTaskRequest withSnsTopicArn(java.lang.String snsTopicArn)

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0- 9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$

Parameters:

snsTopicArn -

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Returns:

A reference to this updated object so that method calls can be chained together.

getSpeechMarkTypes

public java.util.List<java.lang.String> getSpeechMarkTypes()

The type of speech marks returned for the input text.

Returns:

The type of speech marks returned for the input text.

setSpeechMarkTypes

public void setSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes)

The type of speech marks returned for the input text.

Parameters:

speechMarkTypes -

The type of speech marks returned for the input text.

withSpeechMarkTypes

public StartSpeechSynthesisTaskRequest withSpeechMarkTypes(java.lang.String... speechMarkTypes)

The type of speech marks returned for the input text.

Returns a reference to this object so that method calls can be chained together.

Parameters:

speechMarkTypes -

The type of speech marks returned for the input text.

Returns:

A reference to this updated object so that method calls can be chained together.

withSpeechMarkTypes

public StartSpeechSynthesisTaskRequest withSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes)

The type of speech marks returned for the input text.

Returns a reference to this object so that method calls can be chained together.

Parameters:

speechMarkTypes -

The type of speech marks returned for the input text.

Returns:

A reference to this updated object so that method calls can be chained together.

getText

public java.lang.String getText()

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Returns:

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

setText

public void setText(java.lang.String text)

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Parameters:

text -

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

withText

public StartSpeechSynthesisTaskRequest withText(java.lang.String text)

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Returns a reference to this object so that method calls can be chained together.

Parameters:

text -

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Returns:

A reference to this updated object so that method calls can be chained together.

getTextType

public java.lang.String getTextType()

Specifies whether the input text is plain text or SSML. The default value is plain text.

Constraints:
Allowed Values: ssml, text

Returns:

Specifies whether the input text is plain text or SSML. The default value is plain text.

See Also:

TextType

setTextType

public void setTextType(java.lang.String textType)

Specifies whether the input text is plain text or SSML. The default value is plain text.

Constraints:
Allowed Values: ssml, text

Parameters:

textType -

Specifies whether the input text is plain text or SSML. The default value is plain text.

See Also:

TextType

withTextType

public StartSpeechSynthesisTaskRequest withTextType(java.lang.String textType)

Specifies whether the input text is plain text or SSML. The default value is plain text.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ssml, text

Parameters:

textType -

Specifies whether the input text is plain text or SSML. The default value is plain text.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TextType

setTextType

public void setTextType(TextType textType)

Specifies whether the input text is plain text or SSML. The default value is plain text.

Constraints:
Allowed Values: ssml, text

Parameters:

textType -

Specifies whether the input text is plain text or SSML. The default value is plain text.

See Also:

TextType

withTextType

public StartSpeechSynthesisTaskRequest withTextType(TextType textType)

Specifies whether the input text is plain text or SSML. The default value is plain text.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ssml, text

Parameters:

textType -

Specifies whether the input text is plain text or SSML. The default value is plain text.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TextType

getVoiceId

public java.lang.String getVoiceId()

Voice ID to use for the synthesis.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu

Returns:

Voice ID to use for the synthesis.

See Also:

VoiceId

setVoiceId

public void setVoiceId(java.lang.String voiceId)

Voice ID to use for the synthesis.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu

Parameters:

voiceId -

Voice ID to use for the synthesis.

See Also:

VoiceId

withVoiceId

public StartSpeechSynthesisTaskRequest withVoiceId(java.lang.String voiceId)

Voice ID to use for the synthesis.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu

Parameters:

voiceId -

Voice ID to use for the synthesis.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VoiceId

setVoiceId

public void setVoiceId(VoiceId voiceId)

Voice ID to use for the synthesis.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu

Parameters:

voiceId -

Voice ID to use for the synthesis.

See Also:

VoiceId

withVoiceId

public StartSpeechSynthesisTaskRequest withVoiceId(VoiceId voiceId)

Voice ID to use for the synthesis.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu

Parameters:

voiceId -

Voice ID to use for the synthesis.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VoiceId

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object