/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.polly.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* 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. The SpeechSynthesisTask * object is available for 72 hours after starting the asynchronous synthesis * task. *

*/ public class StartSpeechSynthesisTaskRequest extends AmazonWebServiceRequest implements Serializable { /** *

* 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 */ private String engine; /** *

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

*

* 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE */ private String languageCode; /** *

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

*/ private java.util.List lexiconNames; /** *

* 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 */ private String outputFormat; /** *

* 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]$
*/ private String outputS3BucketName; /** *

* The Amazon S3 key prefix for the output speech file. *

*

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

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

*/ private String sampleRate; /** *

* 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}$
*/ private String snsTopicArn; /** *

* The type of speech marks returned for the input text. *

*/ private java.util.List speechMarkTypes; /** *

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

*/ private String text; /** *

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

*

* Constraints:
* Allowed Values: ssml, text */ private String textType; /** *

* 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, Gabrielle, 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, Aria, * Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, * Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, * Stephen, Kazuha, Tomoko, Niamh, Sofie */ private String voiceId; /** *

* 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 * * @return

* 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 Engine */ public String getEngine() { return 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 * * @param 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 Engine */ public void setEngine(String engine) { this.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 * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see Engine */ public StartSpeechSynthesisTaskRequest withEngine(String engine) { this.engine = engine; return this; } /** *

* 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 * * @param 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 Engine */ public void setEngine(Engine engine) { this.engine = engine.toString(); } /** *

* 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 * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see Engine */ public StartSpeechSynthesisTaskRequest withEngine(Engine engine) { this.engine = engine.toString(); return this; } /** *

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

*

* 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE * * @return

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

* @see LanguageCode */ public String getLanguageCode() { return 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. *

*

* 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE * * @param 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. *

* @see LanguageCode */ public void setLanguageCode(String languageCode) { this.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. *

*

* 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public StartSpeechSynthesisTaskRequest withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** *

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

*

* 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE * * @param 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. *

* @see LanguageCode */ public void setLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** *

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

*

* 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public StartSpeechSynthesisTaskRequest withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** *

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

* * @return

* 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 java.util.List getLexiconNames() { return 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. *

* * @param 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 setLexiconNames(java.util.Collection lexiconNames) { if (lexiconNames == null) { this.lexiconNames = null; return; } this.lexiconNames = new java.util.ArrayList(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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withLexiconNames(String... lexiconNames) { if (getLexiconNames() == null) { this.lexiconNames = new java.util.ArrayList(lexiconNames.length); } for (String value : lexiconNames) { this.lexiconNames.add(value); } return this; } /** *

* 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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withLexiconNames( java.util.Collection lexiconNames) { setLexiconNames(lexiconNames); return this; } /** *

* 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 * * @return

* 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 OutputFormat */ public String getOutputFormat() { return 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 * * @param 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 OutputFormat */ public void setOutputFormat(String outputFormat) { this.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 * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see OutputFormat */ public StartSpeechSynthesisTaskRequest withOutputFormat(String outputFormat) { this.outputFormat = outputFormat; return this; } /** *

* 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 * * @param 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 OutputFormat */ public void setOutputFormat(OutputFormat outputFormat) { this.outputFormat = outputFormat.toString(); } /** *

* 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 * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see OutputFormat */ public StartSpeechSynthesisTaskRequest withOutputFormat(OutputFormat outputFormat) { this.outputFormat = outputFormat.toString(); return this; } /** *

* 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]$
* * @return

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

*/ public String getOutputS3BucketName() { return 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]$
* * @param outputS3BucketName

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

*/ public void setOutputS3BucketName(String outputS3BucketName) { this.outputS3BucketName = 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]$
* * @param outputS3BucketName

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withOutputS3BucketName(String outputS3BucketName) { this.outputS3BucketName = outputS3BucketName; return this; } /** *

* The Amazon S3 key prefix for the output speech file. *

*

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

* The Amazon S3 key prefix for the output speech file. *

*/ public String getOutputS3KeyPrefix() { return outputS3KeyPrefix; } /** *

* The Amazon S3 key prefix for the output speech file. *

*

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

* The Amazon S3 key prefix for the output speech file. *

*/ public void setOutputS3KeyPrefix(String outputS3KeyPrefix) { this.outputS3KeyPrefix = 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}$
* * @param outputS3KeyPrefix

* The Amazon S3 key prefix for the output speech file. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withOutputS3KeyPrefix(String outputS3KeyPrefix) { this.outputS3KeyPrefix = outputS3KeyPrefix; return this; } /** *

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

* * @return

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

*/ public String getSampleRate() { return 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". *

* * @param 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". *

*/ public void setSampleRate(String sampleRate) { this.sampleRate = 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. * * @param 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". *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withSampleRate(String sampleRate) { this.sampleRate = sampleRate; return this; } /** *

* 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}$
* * @return

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

*/ public String getSnsTopicArn() { return 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}$
* * @param snsTopicArn

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

*/ public void setSnsTopicArn(String snsTopicArn) { this.snsTopicArn = 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}$
* * @param snsTopicArn

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withSnsTopicArn(String snsTopicArn) { this.snsTopicArn = snsTopicArn; return this; } /** *

* The type of speech marks returned for the input text. *

* * @return

* The type of speech marks returned for the input text. *

*/ public java.util.List getSpeechMarkTypes() { return speechMarkTypes; } /** *

* The type of speech marks returned for the input text. *

* * @param speechMarkTypes

* The type of speech marks returned for the input text. *

*/ public void setSpeechMarkTypes(java.util.Collection speechMarkTypes) { if (speechMarkTypes == null) { this.speechMarkTypes = null; return; } this.speechMarkTypes = new java.util.ArrayList(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. * * @param speechMarkTypes

* The type of speech marks returned for the input text. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withSpeechMarkTypes(String... speechMarkTypes) { if (getSpeechMarkTypes() == null) { this.speechMarkTypes = new java.util.ArrayList(speechMarkTypes.length); } for (String value : speechMarkTypes) { this.speechMarkTypes.add(value); } return this; } /** *

* The type of speech marks returned for the input text. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param speechMarkTypes

* The type of speech marks returned for the input text. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withSpeechMarkTypes( java.util.Collection speechMarkTypes) { setSpeechMarkTypes(speechMarkTypes); return this; } /** *

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

* * @return

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

*/ public String getText() { return text; } /** *

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

* * @param text

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

*/ public void setText(String text) { this.text = 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. * * @param text

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSpeechSynthesisTaskRequest withText(String text) { this.text = text; return this; } /** *

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

*

* Constraints:
* Allowed Values: ssml, text * * @return

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

* @see TextType */ public String getTextType() { return textType; } /** *

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

*

* Constraints:
* Allowed Values: ssml, text * * @param textType

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

* @see TextType */ public void setTextType(String textType) { this.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 * * @param textType

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

* @return A reference to this updated object so that method calls can be * chained together. * @see TextType */ public StartSpeechSynthesisTaskRequest withTextType(String textType) { this.textType = textType; return this; } /** *

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

*

* Constraints:
* Allowed Values: ssml, text * * @param textType

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

* @see TextType */ public void setTextType(TextType textType) { this.textType = textType.toString(); } /** *

* 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 * * @param textType

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

* @return A reference to this updated object so that method calls can be * chained together. * @see TextType */ public StartSpeechSynthesisTaskRequest withTextType(TextType textType) { this.textType = textType.toString(); return this; } /** *

* 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, Gabrielle, 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, Aria, * Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, * Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, * Stephen, Kazuha, Tomoko, Niamh, Sofie * * @return

* Voice ID to use for the synthesis. *

* @see VoiceId */ public String getVoiceId() { return 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, Gabrielle, 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, Aria, * Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, * Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, * Stephen, Kazuha, Tomoko, Niamh, Sofie * * @param voiceId

* Voice ID to use for the synthesis. *

* @see VoiceId */ public void setVoiceId(String voiceId) { this.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, Gabrielle, 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, Aria, * Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, * Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, * Stephen, Kazuha, Tomoko, Niamh, Sofie * * @param voiceId

* Voice ID to use for the synthesis. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VoiceId */ public StartSpeechSynthesisTaskRequest withVoiceId(String voiceId) { this.voiceId = voiceId; return this; } /** *

* 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, Gabrielle, 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, Aria, * Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, * Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, * Stephen, Kazuha, Tomoko, Niamh, Sofie * * @param voiceId

* Voice ID to use for the synthesis. *

* @see VoiceId */ public void setVoiceId(VoiceId voiceId) { this.voiceId = voiceId.toString(); } /** *

* 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, Gabrielle, 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, Aria, * Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, * Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, * Stephen, Kazuha, Tomoko, Niamh, Sofie * * @param voiceId

* Voice ID to use for the synthesis. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VoiceId */ public StartSpeechSynthesisTaskRequest withVoiceId(VoiceId voiceId) { this.voiceId = voiceId.toString(); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getEngine() != null) sb.append("Engine: " + getEngine() + ","); if (getLanguageCode() != null) sb.append("LanguageCode: " + getLanguageCode() + ","); if (getLexiconNames() != null) sb.append("LexiconNames: " + getLexiconNames() + ","); if (getOutputFormat() != null) sb.append("OutputFormat: " + getOutputFormat() + ","); if (getOutputS3BucketName() != null) sb.append("OutputS3BucketName: " + getOutputS3BucketName() + ","); if (getOutputS3KeyPrefix() != null) sb.append("OutputS3KeyPrefix: " + getOutputS3KeyPrefix() + ","); if (getSampleRate() != null) sb.append("SampleRate: " + getSampleRate() + ","); if (getSnsTopicArn() != null) sb.append("SnsTopicArn: " + getSnsTopicArn() + ","); if (getSpeechMarkTypes() != null) sb.append("SpeechMarkTypes: " + getSpeechMarkTypes() + ","); if (getText() != null) sb.append("Text: " + getText() + ","); if (getTextType() != null) sb.append("TextType: " + getTextType() + ","); if (getVoiceId() != null) sb.append("VoiceId: " + getVoiceId()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getEngine() == null) ? 0 : getEngine().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); hashCode = prime * hashCode + ((getLexiconNames() == null) ? 0 : getLexiconNames().hashCode()); hashCode = prime * hashCode + ((getOutputFormat() == null) ? 0 : getOutputFormat().hashCode()); hashCode = prime * hashCode + ((getOutputS3BucketName() == null) ? 0 : getOutputS3BucketName().hashCode()); hashCode = prime * hashCode + ((getOutputS3KeyPrefix() == null) ? 0 : getOutputS3KeyPrefix().hashCode()); hashCode = prime * hashCode + ((getSampleRate() == null) ? 0 : getSampleRate().hashCode()); hashCode = prime * hashCode + ((getSnsTopicArn() == null) ? 0 : getSnsTopicArn().hashCode()); hashCode = prime * hashCode + ((getSpeechMarkTypes() == null) ? 0 : getSpeechMarkTypes().hashCode()); hashCode = prime * hashCode + ((getText() == null) ? 0 : getText().hashCode()); hashCode = prime * hashCode + ((getTextType() == null) ? 0 : getTextType().hashCode()); hashCode = prime * hashCode + ((getVoiceId() == null) ? 0 : getVoiceId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartSpeechSynthesisTaskRequest == false) return false; StartSpeechSynthesisTaskRequest other = (StartSpeechSynthesisTaskRequest) obj; if (other.getEngine() == null ^ this.getEngine() == null) return false; if (other.getEngine() != null && other.getEngine().equals(this.getEngine()) == false) return false; if (other.getLanguageCode() == null ^ this.getLanguageCode() == null) return false; if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false) return false; if (other.getLexiconNames() == null ^ this.getLexiconNames() == null) return false; if (other.getLexiconNames() != null && other.getLexiconNames().equals(this.getLexiconNames()) == false) return false; if (other.getOutputFormat() == null ^ this.getOutputFormat() == null) return false; if (other.getOutputFormat() != null && other.getOutputFormat().equals(this.getOutputFormat()) == false) return false; if (other.getOutputS3BucketName() == null ^ this.getOutputS3BucketName() == null) return false; if (other.getOutputS3BucketName() != null && other.getOutputS3BucketName().equals(this.getOutputS3BucketName()) == false) return false; if (other.getOutputS3KeyPrefix() == null ^ this.getOutputS3KeyPrefix() == null) return false; if (other.getOutputS3KeyPrefix() != null && other.getOutputS3KeyPrefix().equals(this.getOutputS3KeyPrefix()) == false) return false; if (other.getSampleRate() == null ^ this.getSampleRate() == null) return false; if (other.getSampleRate() != null && other.getSampleRate().equals(this.getSampleRate()) == false) return false; if (other.getSnsTopicArn() == null ^ this.getSnsTopicArn() == null) return false; if (other.getSnsTopicArn() != null && other.getSnsTopicArn().equals(this.getSnsTopicArn()) == false) return false; if (other.getSpeechMarkTypes() == null ^ this.getSpeechMarkTypes() == null) return false; if (other.getSpeechMarkTypes() != null && other.getSpeechMarkTypes().equals(this.getSpeechMarkTypes()) == false) return false; if (other.getText() == null ^ this.getText() == null) return false; if (other.getText() != null && other.getText().equals(this.getText()) == false) return false; if (other.getTextType() == null ^ this.getTextType() == null) return false; if (other.getTextType() != null && other.getTextType().equals(this.getTextType()) == false) return false; if (other.getVoiceId() == null ^ this.getVoiceId() == null) return false; if (other.getVoiceId() != null && other.getVoiceId().equals(this.getVoiceId()) == false) return false; return true; } }