com.amazonaws.services.polly.model.SynthesizeSpeechRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-polly Show documentation
/*
* Copyright 2019-2024 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SynthesizeSpeechRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an
* engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected
* by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For
* information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
*
* Type: String
*
*
* Valid Values: standard | neural | long-form | generative
*
*
* Required: Yes
*
*/
private String engine;
/**
*
* Optional language code for the Synthesize Speech 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.
*
*/
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. For information about
* storing lexicons, see PutLexicon.
*
*/
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.
*
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*/
private String outputFormat;
/**
*
* 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".
*
*/
private String sampleRate;
/**
*
* The type of speech marks returned for the input text.
*
*/
private java.util.List speechMarkTypes;
/**
*
* 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. For more information,
* see Using SSML.
*
*/
private String textType;
/**
*
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
*
*/
private String voiceId;
/**
*
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an
* engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected
* by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For
* information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
*
* Type: String
*
*
* Valid Values: standard | neural | long-form | generative
*
*
* Required: Yes
*
*
* @param engine
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide
* an engine that is supported by the voice you select. If you don't provide an engine, the standard engine
* is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an
* error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
* Type: String
*
*
* Valid Values: standard | neural | long-form |
* generative
*
*
* Required: Yes
* @see Engine
*/
public void setEngine(String engine) {
this.engine = engine;
}
/**
*
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an
* engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected
* by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For
* information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
*
* Type: String
*
*
* Valid Values: standard | neural | long-form | generative
*
*
* Required: Yes
*
*
* @return Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide
* an engine that is supported by the voice you select. If you don't provide an engine, the standard engine
* is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an
* error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
* Type: String
*
*
* Valid Values: standard | neural | long-form |
* generative
*
*
* Required: Yes
* @see Engine
*/
public String getEngine() {
return this.engine;
}
/**
*
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an
* engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected
* by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For
* information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
*
* Type: String
*
*
* Valid Values: standard | neural | long-form | generative
*
*
* Required: Yes
*
*
* @param engine
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide
* an engine that is supported by the voice you select. If you don't provide an engine, the standard engine
* is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an
* error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
* Type: String
*
*
* Valid Values: standard | neural | long-form |
* generative
*
*
* Required: Yes
* @return Returns a reference to this object so that method calls can be chained together.
* @see Engine
*/
public SynthesizeSpeechRequest withEngine(String engine) {
setEngine(engine);
return this;
}
/**
*
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an
* engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected
* by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For
* information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
*
* Type: String
*
*
* Valid Values: standard | neural | long-form | generative
*
*
* Required: Yes
*
*
* @param engine
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide
* an engine that is supported by the voice you select. If you don't provide an engine, the standard engine
* is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an
* error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
* Type: String
*
*
* Valid Values: standard | neural | long-form |
* generative
*
*
* Required: Yes
* @see Engine
*/
public void setEngine(Engine engine) {
withEngine(engine);
}
/**
*
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an
* engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected
* by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For
* information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
*
* Type: String
*
*
* Valid Values: standard | neural | long-form | generative
*
*
* Required: Yes
*
*
* @param engine
* Specifies the engine (standard, neural, long-form, or
* generative) for Amazon Polly to use when processing input text for speech synthesis. Provide
* an engine that is supported by the voice you select. If you don't provide an engine, the standard engine
* is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an
* error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
*
* Type: String
*
*
* Valid Values: standard | neural | long-form |
* generative
*
*
* Required: Yes
* @return Returns a reference to this object so that method calls can be chained together.
* @see Engine
*/
public SynthesizeSpeechRequest withEngine(Engine engine) {
this.engine = engine.toString();
return this;
}
/**
*
* Optional language code for the Synthesize Speech 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.
*
*
* @param languageCode
* Optional language code for the Synthesize Speech 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 Synthesize Speech 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 Optional language code for the Synthesize Speech 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 this.languageCode;
}
/**
*
* Optional language code for the Synthesize Speech 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.
*
*
* @param languageCode
* Optional language code for the Synthesize Speech 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 Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public SynthesizeSpeechRequest withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
*
* Optional language code for the Synthesize Speech 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.
*
*
* @param languageCode
* Optional language code for the Synthesize Speech 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) {
withLanguageCode(languageCode);
}
/**
*
* Optional language code for the Synthesize Speech 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.
*
*
* @param languageCode
* Optional language code for the Synthesize Speech 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 Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public SynthesizeSpeechRequest 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. For information about
* storing lexicons, see PutLexicon.
*
*
* @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. For information
* about storing lexicons, see PutLexicon.
*/
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. For information about
* storing lexicons, see PutLexicon.
*
*
* @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. For information
* about storing lexicons, see PutLexicon.
*/
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. For information about
* storing lexicons, see PutLexicon.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLexiconNames(java.util.Collection)} or {@link #withLexiconNames(java.util.Collection)} if you want to
* override the existing values.
*
*
* @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. For information
* about storing lexicons, see PutLexicon.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SynthesizeSpeechRequest withLexiconNames(String... lexiconNames) {
if (this.lexiconNames == null) {
setLexiconNames(new java.util.ArrayList(lexiconNames.length));
}
for (String ele : lexiconNames) {
this.lexiconNames.add(ele);
}
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. For information about
* storing lexicons, see PutLexicon.
*
*
* @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. For information
* about storing lexicons, see PutLexicon.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SynthesizeSpeechRequest 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.
*
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* @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.
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian
* format.
* @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.
*
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* @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.
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian
* format.
* @see OutputFormat
*/
public String getOutputFormat() {
return this.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.
*
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* @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.
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian
* format.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OutputFormat
*/
public SynthesizeSpeechRequest withOutputFormat(String outputFormat) {
setOutputFormat(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.
*
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* @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.
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian
* format.
* @see OutputFormat
*/
public void setOutputFormat(OutputFormat outputFormat) {
withOutputFormat(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.
*
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* @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.
*
* When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian
* format.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OutputFormat
*/
public SynthesizeSpeechRequest withOutputFormat(OutputFormat outputFormat) {
this.outputFormat = outputFormat.toString();
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". 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".
*
*
* @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". 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 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". 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".
*
*
* @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". 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() {
return this.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".
*
*
* @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". 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".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SynthesizeSpeechRequest withSampleRate(String sampleRate) {
setSampleRate(sampleRate);
return this;
}
/**
*
* The type of speech marks returned for the input text.
*
*
* @return The type of speech marks returned for the input text.
* @see SpeechMarkType
*/
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.
* @see SpeechMarkType
*/
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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSpeechMarkTypes(java.util.Collection)} or {@link #withSpeechMarkTypes(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param speechMarkTypes
* The type of speech marks returned for the input text.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpeechMarkType
*/
public SynthesizeSpeechRequest withSpeechMarkTypes(String... speechMarkTypes) {
if (this.speechMarkTypes == null) {
setSpeechMarkTypes(new java.util.ArrayList(speechMarkTypes.length));
}
for (String ele : speechMarkTypes) {
this.speechMarkTypes.add(ele);
}
return this;
}
/**
*
* The type of speech marks returned for the input text.
*
*
* @param speechMarkTypes
* The type of speech marks returned for the input text.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpeechMarkType
*/
public SynthesizeSpeechRequest withSpeechMarkTypes(java.util.Collection speechMarkTypes) {
setSpeechMarkTypes(speechMarkTypes);
return this;
}
/**
*
* The type of speech marks returned for the input text.
*
*
* @param speechMarkTypes
* The type of speech marks returned for the input text.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpeechMarkType
*/
public SynthesizeSpeechRequest withSpeechMarkTypes(SpeechMarkType... speechMarkTypes) {
java.util.ArrayList speechMarkTypesCopy = new java.util.ArrayList(speechMarkTypes.length);
for (SpeechMarkType value : speechMarkTypes) {
speechMarkTypesCopy.add(value.toString());
}
if (getSpeechMarkTypes() == null) {
setSpeechMarkTypes(speechMarkTypesCopy);
} else {
getSpeechMarkTypes().addAll(speechMarkTypesCopy);
}
return this;
}
/**
*
* Input text to synthesize. If you specify ssml as the TextType, follow the SSML format
* for the input text.
*
*
* @param text
* 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;
}
/**
*
* Input text to synthesize. If you specify ssml as the TextType, follow the SSML format
* for the input text.
*
*
* @return Input text to synthesize. If you specify ssml as the TextType, follow the SSML
* format for the input text.
*/
public String getText() {
return this.text;
}
/**
*
* Input text to synthesize. If you specify ssml as the TextType, follow the SSML format
* for the input text.
*
*
* @param text
* Input text to synthesize. If you specify ssml as the TextType, follow the SSML
* format for the input text.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SynthesizeSpeechRequest withText(String text) {
setText(text);
return this;
}
/**
*
* Specifies whether the input text is plain text or SSML. The default value is plain text. For more information,
* see Using SSML.
*
*
* @param textType
* Specifies whether the input text is plain text or SSML. The default value is plain text. For more
* information, see Using SSML.
* @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. For more information,
* see Using SSML.
*
*
* @return Specifies whether the input text is plain text or SSML. The default value is plain text. For more
* information, see Using SSML.
* @see TextType
*/
public String getTextType() {
return this.textType;
}
/**
*
* Specifies whether the input text is plain text or SSML. The default value is plain text. For more information,
* see Using SSML.
*
*
* @param textType
* Specifies whether the input text is plain text or SSML. The default value is plain text. For more
* information, see Using SSML.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TextType
*/
public SynthesizeSpeechRequest withTextType(String textType) {
setTextType(textType);
return this;
}
/**
*
* Specifies whether the input text is plain text or SSML. The default value is plain text. For more information,
* see Using SSML.
*
*
* @param textType
* Specifies whether the input text is plain text or SSML. The default value is plain text. For more
* information, see Using SSML.
* @see TextType
*/
public void setTextType(TextType textType) {
withTextType(textType);
}
/**
*
* Specifies whether the input text is plain text or SSML. The default value is plain text. For more information,
* see Using SSML.
*
*
* @param textType
* Specifies whether the input text is plain text or SSML. The default value is plain text. For more
* information, see Using SSML.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TextType
*/
public SynthesizeSpeechRequest withTextType(TextType textType) {
this.textType = textType.toString();
return this;
}
/**
*
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
*
*
* @param voiceId
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
* @see VoiceId
*/
public void setVoiceId(String voiceId) {
this.voiceId = voiceId;
}
/**
*
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
*
*
* @return Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
* @see VoiceId
*/
public String getVoiceId() {
return this.voiceId;
}
/**
*
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
*
*
* @param voiceId
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VoiceId
*/
public SynthesizeSpeechRequest withVoiceId(String voiceId) {
setVoiceId(voiceId);
return this;
}
/**
*
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
*
*
* @param voiceId
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
* @see VoiceId
*/
public void setVoiceId(VoiceId voiceId) {
withVoiceId(voiceId);
}
/**
*
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
*
*
* @param voiceId
* Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VoiceId
*/
public SynthesizeSpeechRequest withVoiceId(VoiceId voiceId) {
this.voiceId = voiceId.toString();
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @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: ").append(getEngine()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode()).append(",");
if (getLexiconNames() != null)
sb.append("LexiconNames: ").append(getLexiconNames()).append(",");
if (getOutputFormat() != null)
sb.append("OutputFormat: ").append(getOutputFormat()).append(",");
if (getSampleRate() != null)
sb.append("SampleRate: ").append(getSampleRate()).append(",");
if (getSpeechMarkTypes() != null)
sb.append("SpeechMarkTypes: ").append(getSpeechMarkTypes()).append(",");
if (getText() != null)
sb.append("Text: ").append(getText()).append(",");
if (getTextType() != null)
sb.append("TextType: ").append(getTextType()).append(",");
if (getVoiceId() != null)
sb.append("VoiceId: ").append(getVoiceId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SynthesizeSpeechRequest == false)
return false;
SynthesizeSpeechRequest other = (SynthesizeSpeechRequest) 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.getSampleRate() == null ^ this.getSampleRate() == null)
return false;
if (other.getSampleRate() != null && other.getSampleRate().equals(this.getSampleRate()) == 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;
}
@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 + ((getSampleRate() == null) ? 0 : getSampleRate().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 SynthesizeSpeechRequest clone() {
return (SynthesizeSpeechRequest) super.clone();
}
}