com.amazonaws.services.polly.model.Voice 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Description of the voice.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Voice implements Serializable, Cloneable, StructuredPojo {
/**
*
* Gender of the voice.
*
*/
private String gender;
/**
*
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech
* operation.
*
*/
private String id;
/**
*
* Language code of the voice.
*
*/
private String languageCode;
/**
*
* Human readable name of the language in English.
*
*/
private String languageName;
/**
*
* Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might
* display in your application.
*
*/
private String name;
/**
*
* Additional codes for languages available for the specified voice in addition to its default language.
*
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the
* code hi-IN.
*
*/
private java.util.List additionalLanguageCodes;
/**
*
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
*
*/
private java.util.List supportedEngines;
/**
*
* Gender of the voice.
*
*
* @param gender
* Gender of the voice.
* @see Gender
*/
public void setGender(String gender) {
this.gender = gender;
}
/**
*
* Gender of the voice.
*
*
* @return Gender of the voice.
* @see Gender
*/
public String getGender() {
return this.gender;
}
/**
*
* Gender of the voice.
*
*
* @param gender
* Gender of the voice.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Gender
*/
public Voice withGender(String gender) {
setGender(gender);
return this;
}
/**
*
* Gender of the voice.
*
*
* @param gender
* Gender of the voice.
* @see Gender
*/
public void setGender(Gender gender) {
withGender(gender);
}
/**
*
* Gender of the voice.
*
*
* @param gender
* Gender of the voice.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Gender
*/
public Voice withGender(Gender gender) {
this.gender = gender.toString();
return this;
}
/**
*
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech
* operation.
*
*
* @param id
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the
* SynthesizeSpeech operation.
* @see VoiceId
*/
public void setId(String id) {
this.id = id;
}
/**
*
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech
* operation.
*
*
* @return Amazon Polly assigned voice ID. This is the ID that you specify when calling the
* SynthesizeSpeech operation.
* @see VoiceId
*/
public String getId() {
return this.id;
}
/**
*
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech
* operation.
*
*
* @param id
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the
* SynthesizeSpeech operation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VoiceId
*/
public Voice withId(String id) {
setId(id);
return this;
}
/**
*
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech
* operation.
*
*
* @param id
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the
* SynthesizeSpeech operation.
* @see VoiceId
*/
public void setId(VoiceId id) {
withId(id);
}
/**
*
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech
* operation.
*
*
* @param id
* Amazon Polly assigned voice ID. This is the ID that you specify when calling the
* SynthesizeSpeech operation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VoiceId
*/
public Voice withId(VoiceId id) {
this.id = id.toString();
return this;
}
/**
*
* Language code of the voice.
*
*
* @param languageCode
* Language code of the voice.
* @see LanguageCode
*/
public void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
/**
*
* Language code of the voice.
*
*
* @return Language code of the voice.
* @see LanguageCode
*/
public String getLanguageCode() {
return this.languageCode;
}
/**
*
* Language code of the voice.
*
*
* @param languageCode
* Language code of the voice.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public Voice withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
*
* Language code of the voice.
*
*
* @param languageCode
* Language code of the voice.
* @see LanguageCode
*/
public void setLanguageCode(LanguageCode languageCode) {
withLanguageCode(languageCode);
}
/**
*
* Language code of the voice.
*
*
* @param languageCode
* Language code of the voice.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public Voice withLanguageCode(LanguageCode languageCode) {
this.languageCode = languageCode.toString();
return this;
}
/**
*
* Human readable name of the language in English.
*
*
* @param languageName
* Human readable name of the language in English.
*/
public void setLanguageName(String languageName) {
this.languageName = languageName;
}
/**
*
* Human readable name of the language in English.
*
*
* @return Human readable name of the language in English.
*/
public String getLanguageName() {
return this.languageName;
}
/**
*
* Human readable name of the language in English.
*
*
* @param languageName
* Human readable name of the language in English.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Voice withLanguageName(String languageName) {
setLanguageName(languageName);
return this;
}
/**
*
* Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might
* display in your application.
*
*
* @param name
* Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you
* might display in your application.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might
* display in your application.
*
*
* @return Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you
* might display in your application.
*/
public String getName() {
return this.name;
}
/**
*
* Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might
* display in your application.
*
*
* @param name
* Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you
* might display in your application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Voice withName(String name) {
setName(name);
return this;
}
/**
*
* Additional codes for languages available for the specified voice in addition to its default language.
*
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the
* code hi-IN.
*
*
* @return Additional codes for languages available for the specified voice in addition to its default language.
*
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show
* the code hi-IN.
* @see LanguageCode
*/
public java.util.List getAdditionalLanguageCodes() {
return additionalLanguageCodes;
}
/**
*
* Additional codes for languages available for the specified voice in addition to its default language.
*
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the
* code hi-IN.
*
*
* @param additionalLanguageCodes
* Additional codes for languages available for the specified voice in addition to its default language.
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show
* the code hi-IN.
* @see LanguageCode
*/
public void setAdditionalLanguageCodes(java.util.Collection additionalLanguageCodes) {
if (additionalLanguageCodes == null) {
this.additionalLanguageCodes = null;
return;
}
this.additionalLanguageCodes = new java.util.ArrayList(additionalLanguageCodes);
}
/**
*
* Additional codes for languages available for the specified voice in addition to its default language.
*
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the
* code hi-IN.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAdditionalLanguageCodes(java.util.Collection)} or
* {@link #withAdditionalLanguageCodes(java.util.Collection)} if you want to override the existing values.
*
*
* @param additionalLanguageCodes
* Additional codes for languages available for the specified voice in addition to its default language.
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show
* the code hi-IN.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public Voice withAdditionalLanguageCodes(String... additionalLanguageCodes) {
if (this.additionalLanguageCodes == null) {
setAdditionalLanguageCodes(new java.util.ArrayList(additionalLanguageCodes.length));
}
for (String ele : additionalLanguageCodes) {
this.additionalLanguageCodes.add(ele);
}
return this;
}
/**
*
* Additional codes for languages available for the specified voice in addition to its default language.
*
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the
* code hi-IN.
*
*
* @param additionalLanguageCodes
* Additional codes for languages available for the specified voice in addition to its default language.
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show
* the code hi-IN.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public Voice withAdditionalLanguageCodes(java.util.Collection additionalLanguageCodes) {
setAdditionalLanguageCodes(additionalLanguageCodes);
return this;
}
/**
*
* Additional codes for languages available for the specified voice in addition to its default language.
*
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the
* code hi-IN.
*
*
* @param additionalLanguageCodes
* Additional codes for languages available for the specified voice in addition to its default language.
*
* For example, the default language for Aditi is Indian English (en-IN) because it was first used for that
* language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show
* the code hi-IN.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public Voice withAdditionalLanguageCodes(LanguageCode... additionalLanguageCodes) {
java.util.ArrayList additionalLanguageCodesCopy = new java.util.ArrayList(additionalLanguageCodes.length);
for (LanguageCode value : additionalLanguageCodes) {
additionalLanguageCodesCopy.add(value.toString());
}
if (getAdditionalLanguageCodes() == null) {
setAdditionalLanguageCodes(additionalLanguageCodesCopy);
} else {
getAdditionalLanguageCodes().addAll(additionalLanguageCodesCopy);
}
return this;
}
/**
*
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
*
*
* @return Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
* @see Engine
*/
public java.util.List getSupportedEngines() {
return supportedEngines;
}
/**
*
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
*
*
* @param supportedEngines
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
* @see Engine
*/
public void setSupportedEngines(java.util.Collection supportedEngines) {
if (supportedEngines == null) {
this.supportedEngines = null;
return;
}
this.supportedEngines = new java.util.ArrayList(supportedEngines);
}
/**
*
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSupportedEngines(java.util.Collection)} or {@link #withSupportedEngines(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param supportedEngines
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Engine
*/
public Voice withSupportedEngines(String... supportedEngines) {
if (this.supportedEngines == null) {
setSupportedEngines(new java.util.ArrayList(supportedEngines.length));
}
for (String ele : supportedEngines) {
this.supportedEngines.add(ele);
}
return this;
}
/**
*
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
*
*
* @param supportedEngines
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Engine
*/
public Voice withSupportedEngines(java.util.Collection supportedEngines) {
setSupportedEngines(supportedEngines);
return this;
}
/**
*
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
*
*
* @param supportedEngines
* Specifies which engines (standard, neural, long-form or
* generative) are supported by a given voice.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Engine
*/
public Voice withSupportedEngines(Engine... supportedEngines) {
java.util.ArrayList supportedEnginesCopy = new java.util.ArrayList(supportedEngines.length);
for (Engine value : supportedEngines) {
supportedEnginesCopy.add(value.toString());
}
if (getSupportedEngines() == null) {
setSupportedEngines(supportedEnginesCopy);
} else {
getSupportedEngines().addAll(supportedEnginesCopy);
}
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 (getGender() != null)
sb.append("Gender: ").append(getGender()).append(",");
if (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode()).append(",");
if (getLanguageName() != null)
sb.append("LanguageName: ").append(getLanguageName()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getAdditionalLanguageCodes() != null)
sb.append("AdditionalLanguageCodes: ").append(getAdditionalLanguageCodes()).append(",");
if (getSupportedEngines() != null)
sb.append("SupportedEngines: ").append(getSupportedEngines());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Voice == false)
return false;
Voice other = (Voice) obj;
if (other.getGender() == null ^ this.getGender() == null)
return false;
if (other.getGender() != null && other.getGender().equals(this.getGender()) == false)
return false;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == 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.getLanguageName() == null ^ this.getLanguageName() == null)
return false;
if (other.getLanguageName() != null && other.getLanguageName().equals(this.getLanguageName()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getAdditionalLanguageCodes() == null ^ this.getAdditionalLanguageCodes() == null)
return false;
if (other.getAdditionalLanguageCodes() != null && other.getAdditionalLanguageCodes().equals(this.getAdditionalLanguageCodes()) == false)
return false;
if (other.getSupportedEngines() == null ^ this.getSupportedEngines() == null)
return false;
if (other.getSupportedEngines() != null && other.getSupportedEngines().equals(this.getSupportedEngines()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGender() == null) ? 0 : getGender().hashCode());
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getLanguageName() == null) ? 0 : getLanguageName().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getAdditionalLanguageCodes() == null) ? 0 : getAdditionalLanguageCodes().hashCode());
hashCode = prime * hashCode + ((getSupportedEngines() == null) ? 0 : getSupportedEngines().hashCode());
return hashCode;
}
@Override
public Voice clone() {
try {
return (Voice) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.polly.model.transform.VoiceMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}