/* * Copyright 2018-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.pinpoint.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* Specifies the content and settings for a message template that can be used in messages that are sent through the * voice channel. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class VoiceTemplateRequest implements Serializable, Cloneable, StructuredPojo { /** *

* The text of the script to use in messages that are based on the message template, in plain text format. *

*/ private String body; /** *

* A JSON object that specifies the default values to use for message variables in the message template. This object * is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines * the default value for that variable. When you create a message that's based on the template, you can override * these defaults with message-specific and address-specific variables and values. *

*/ private String defaultSubstitutions; /** *

* The code for the language to use when synthesizing the text of the script in messages that are based on the * message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide. *

*/ private String languageCode; /** * *

* As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not * processed and an error code is not returned. To manage tags we recommend using either Tags in the API * Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK. *

* *

* (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message * template. Each tag consists of a required tag key and an associated tag value. *

*/ private java.util.Map tags; /** *

* A custom description of the message template. *

*/ private String templateDescription; /** *

* The name of the voice to use when delivering messages that are based on the message template. For a list of * supported voices, see the Amazon Polly * Developer Guide. *

*/ private String voiceId; /** *

* The text of the script to use in messages that are based on the message template, in plain text format. *

* * @param body * The text of the script to use in messages that are based on the message template, in plain text format. */ public void setBody(String body) { this.body = body; } /** *

* The text of the script to use in messages that are based on the message template, in plain text format. *

* * @return The text of the script to use in messages that are based on the message template, in plain text format. */ public String getBody() { return this.body; } /** *

* The text of the script to use in messages that are based on the message template, in plain text format. *

* * @param body * The text of the script to use in messages that are based on the message template, in plain text format. * @return Returns a reference to this object so that method calls can be chained together. */ public VoiceTemplateRequest withBody(String body) { setBody(body); return this; } /** *

* * @param defaultSubstitutions * A JSON object that specifies the default values to use for message variables in the message template. This * object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding * value defines the default value for that variable. When you create a message that's based on the template, * you can override these defaults with message-specific and address-specific variables and values. */ public void setDefaultSubstitutions(String defaultSubstitutions) { this.defaultSubstitutions = defaultSubstitutions; } /** *

* * @return A JSON object that specifies the default values to use for message variables in the message template. * This object is a set of key-value pairs. Each key defines a message variable in the template. The * corresponding value defines the default value for that variable. When you create a message that's based * on the template, you can override these defaults with message-specific and address-specific variables and * values. */ public String getDefaultSubstitutions() { return this.defaultSubstitutions; } /** *

* * @param defaultSubstitutions * A JSON object that specifies the default values to use for message variables in the message template. This * object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding * value defines the default value for that variable. When you create a message that's based on the template, * you can override these defaults with message-specific and address-specific variables and values. * @return Returns a reference to this object so that method calls can be chained together. */ public VoiceTemplateRequest withDefaultSubstitutions(String defaultSubstitutions) { setDefaultSubstitutions(defaultSubstitutions); return this; } /** *

* * @param languageCode * The code for the language to use when synthesizing the text of the script in messages that are based on * the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide. */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** *

* * @return The code for the language to use when synthesizing the text of the script in messages that are based on * the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide. */ public String getLanguageCode() { return this.languageCode; } /** *

* * @param languageCode * The code for the language to use when synthesizing the text of the script in messages that are based on * the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public VoiceTemplateRequest withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** * *

* *

* (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message * template. Each tag consists of a required tag key and an associated tag value. *

* * @return As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags * is not processed and an error code is not returned. To manage tags we recommend using either Tags in the * API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

*/ public java.util.Map getTags() { return tags; } /** * *

* *

* (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message * template. Each tag consists of a required tag key and an associated tag value. *

* * @param tags * As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags * is not processed and an error code is not returned. To manage tags we recommend using either Tags in the * API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

*/ public void setTags(java.util.Map tags) { this.tags = tags; } /** * *

* *

* (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message * template. Each tag consists of a required tag key and an associated tag value. *

* @return Returns a reference to this object so that method calls can be chained together. */ public VoiceTemplateRequest withTags(java.util.Map tags) { setTags(tags); return this; } /** * Add a single Tags entry * * @see VoiceTemplateRequest#withTags * @returns a reference to this object so that method calls can be chained together. */ public VoiceTemplateRequest addTagsEntry(String key, String value) { if (null == this.tags) { this.tags = new java.util.HashMap(); } if (this.tags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.tags.put(key, value); return this; } /** * Removes all the entries added into Tags. * * @return Returns a reference to this object so that method calls can be chained together. */ public VoiceTemplateRequest clearTagsEntries() { this.tags = null; return this; } /** *

* A custom description of the message template. *

* * @param templateDescription * A custom description of the message template. */ public void setTemplateDescription(String templateDescription) { this.templateDescription = templateDescription; } /** *

* A custom description of the message template. *

* * @return A custom description of the message template. */ public String getTemplateDescription() { return this.templateDescription; } /** *

* A custom description of the message template. *

* * @param templateDescription * A custom description of the message template. * @return Returns a reference to this object so that method calls can be chained together. */ public VoiceTemplateRequest withTemplateDescription(String templateDescription) { setTemplateDescription(templateDescription); return this; } /** *

* The name of the voice to use when delivering messages that are based on the message template. For a list of * supported voices, see the Amazon Polly * Developer Guide. *

* * @return The name of the voice to use when delivering messages that are based on the message template. For a list * of supported voices, see the Amazon * Polly Developer Guide. */ public String getVoiceId() { return this.voiceId; } /** *

* The name of the voice to use when delivering messages that are based on the message template. For a list of * supported voices, see the Amazon Polly * Developer Guide. *

* * @param voiceId * The name of the voice to use when delivering messages that are based on the message template. For a list * of supported voices, see the Amazon * Polly Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public VoiceTemplateRequest withVoiceId(String voiceId) { setVoiceId(voiceId); 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 (getBody() != null) sb.append("Body: ").append(getBody()).append(","); if (getDefaultSubstitutions() != null) sb.append("DefaultSubstitutions: ").append(getDefaultSubstitutions()).append(","); if (getLanguageCode() != null) sb.append("LanguageCode: ").append(getLanguageCode()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getTemplateDescription() != null) sb.append("TemplateDescription: ").append(getTemplateDescription()).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 VoiceTemplateRequest == false) return false; VoiceTemplateRequest other = (VoiceTemplateRequest) obj; if (other.getBody() == null ^ this.getBody() == null) return false; if (other.getBody() != null && other.getBody().equals(this.getBody()) == false) return false; if (other.getDefaultSubstitutions() == null ^ this.getDefaultSubstitutions() == null) return false; if (other.getDefaultSubstitutions() != null && other.getDefaultSubstitutions().equals(this.getDefaultSubstitutions()) == 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.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getTemplateDescription() == null ^ this.getTemplateDescription() == null) return false; if (other.getTemplateDescription() != null && other.getTemplateDescription().equals(this.getTemplateDescription()) == 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 + ((getBody() == null) ? 0 : getBody().hashCode()); hashCode = prime * hashCode + ((getDefaultSubstitutions() == null) ? 0 : getDefaultSubstitutions().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getTemplateDescription() == null) ? 0 : getTemplateDescription().hashCode()); hashCode = prime * hashCode + ((getVoiceId() == null) ? 0 : getVoiceId().hashCode()); return hashCode; } @Override public VoiceTemplateRequest clone() { try { return (VoiceTemplateRequest) 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.pinpoint.model.transform.VoiceTemplateRequestMarshaller.getInstance().marshall(this, protocolMarshaller); } }