com.amazonaws.services.polly.model.DescribeVoicesRequest 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 DescribeVoicesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
*
*/
private String engine;
/**
*
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list
* of voices returned. If you don't specify this optional parameter, all available voices are returned.
*
*/
private String languageCode;
/**
*
* Boolean value indicating whether to return any bilingual voices that use the specified language as an additional
* language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice
* that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but
* not if you specify no.
*
*/
private Boolean includeAdditionalLanguageCodes;
/**
*
* An opaque pagination token returned from the previous DescribeVoices operation. If present, this
* indicates where to continue the listing.
*
*/
private String nextToken;
/**
*
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
*
*
* @param engine
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
* @see Engine
*/
public void setEngine(String engine) {
this.engine = engine;
}
/**
*
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
*
*
* @return Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
* @see Engine
*/
public String getEngine() {
return this.engine;
}
/**
*
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
*
*
* @param engine
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Engine
*/
public DescribeVoicesRequest withEngine(String engine) {
setEngine(engine);
return this;
}
/**
*
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
*
*
* @param engine
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
* @see Engine
*/
public void setEngine(Engine engine) {
withEngine(engine);
}
/**
*
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
*
*
* @param engine
* Specifies the engine (standard, neural, long-form or
* generative) used by Amazon Polly when processing input text for speech synthesis.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Engine
*/
public DescribeVoicesRequest withEngine(Engine engine) {
this.engine = engine.toString();
return this;
}
/**
*
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list
* of voices returned. If you don't specify this optional parameter, all available voices are returned.
*
*
* @param languageCode
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering
* the list of voices returned. If you don't specify this optional parameter, all available voices are
* returned.
* @see LanguageCode
*/
public void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
/**
*
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list
* of voices returned. If you don't specify this optional parameter, all available voices are returned.
*
*
* @return The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering
* the list of voices returned. If you don't specify this optional parameter, all available voices are
* returned.
* @see LanguageCode
*/
public String getLanguageCode() {
return this.languageCode;
}
/**
*
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list
* of voices returned. If you don't specify this optional parameter, all available voices are returned.
*
*
* @param languageCode
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering
* the list of voices returned. If you don't specify this optional parameter, all available voices are
* returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public DescribeVoicesRequest withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
*
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list
* of voices returned. If you don't specify this optional parameter, all available voices are returned.
*
*
* @param languageCode
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering
* the list of voices returned. If you don't specify this optional parameter, all available voices are
* returned.
* @see LanguageCode
*/
public void setLanguageCode(LanguageCode languageCode) {
withLanguageCode(languageCode);
}
/**
*
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list
* of voices returned. If you don't specify this optional parameter, all available voices are returned.
*
*
* @param languageCode
* The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering
* the list of voices returned. If you don't specify this optional parameter, all available voices are
* returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public DescribeVoicesRequest withLanguageCode(LanguageCode languageCode) {
this.languageCode = languageCode.toString();
return this;
}
/**
*
* Boolean value indicating whether to return any bilingual voices that use the specified language as an additional
* language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice
* that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but
* not if you specify no.
*
*
* @param includeAdditionalLanguageCodes
* Boolean value indicating whether to return any bilingual voices that use the specified language as an
* additional language. For instance, if you request all languages that use US English (es-US), and there is
* an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you
* specify yes but not if you specify no.
*/
public void setIncludeAdditionalLanguageCodes(Boolean includeAdditionalLanguageCodes) {
this.includeAdditionalLanguageCodes = includeAdditionalLanguageCodes;
}
/**
*
* Boolean value indicating whether to return any bilingual voices that use the specified language as an additional
* language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice
* that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but
* not if you specify no.
*
*
* @return Boolean value indicating whether to return any bilingual voices that use the specified language as an
* additional language. For instance, if you request all languages that use US English (es-US), and there is
* an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you
* specify yes but not if you specify no.
*/
public Boolean getIncludeAdditionalLanguageCodes() {
return this.includeAdditionalLanguageCodes;
}
/**
*
* Boolean value indicating whether to return any bilingual voices that use the specified language as an additional
* language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice
* that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but
* not if you specify no.
*
*
* @param includeAdditionalLanguageCodes
* Boolean value indicating whether to return any bilingual voices that use the specified language as an
* additional language. For instance, if you request all languages that use US English (es-US), and there is
* an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you
* specify yes but not if you specify no.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeVoicesRequest withIncludeAdditionalLanguageCodes(Boolean includeAdditionalLanguageCodes) {
setIncludeAdditionalLanguageCodes(includeAdditionalLanguageCodes);
return this;
}
/**
*
* Boolean value indicating whether to return any bilingual voices that use the specified language as an additional
* language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice
* that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but
* not if you specify no.
*
*
* @return Boolean value indicating whether to return any bilingual voices that use the specified language as an
* additional language. For instance, if you request all languages that use US English (es-US), and there is
* an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you
* specify yes but not if you specify no.
*/
public Boolean isIncludeAdditionalLanguageCodes() {
return this.includeAdditionalLanguageCodes;
}
/**
*
* An opaque pagination token returned from the previous DescribeVoices operation. If present, this
* indicates where to continue the listing.
*
*
* @param nextToken
* An opaque pagination token returned from the previous DescribeVoices operation. If present,
* this indicates where to continue the listing.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* An opaque pagination token returned from the previous DescribeVoices operation. If present, this
* indicates where to continue the listing.
*
*
* @return An opaque pagination token returned from the previous DescribeVoices operation. If present,
* this indicates where to continue the listing.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* An opaque pagination token returned from the previous DescribeVoices operation. If present, this
* indicates where to continue the listing.
*
*
* @param nextToken
* An opaque pagination token returned from the previous DescribeVoices operation. If present,
* this indicates where to continue the listing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeVoicesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getIncludeAdditionalLanguageCodes() != null)
sb.append("IncludeAdditionalLanguageCodes: ").append(getIncludeAdditionalLanguageCodes()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeVoicesRequest == false)
return false;
DescribeVoicesRequest other = (DescribeVoicesRequest) 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.getIncludeAdditionalLanguageCodes() == null ^ this.getIncludeAdditionalLanguageCodes() == null)
return false;
if (other.getIncludeAdditionalLanguageCodes() != null
&& other.getIncludeAdditionalLanguageCodes().equals(this.getIncludeAdditionalLanguageCodes()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == 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 + ((getIncludeAdditionalLanguageCodes() == null) ? 0 : getIncludeAdditionalLanguageCodes().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeVoicesRequest clone() {
return (DescribeVoicesRequest) super.clone();
}
}