/* * 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 * email channel. *

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

* 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 message body, in HTML format, to use in email messages that are based on the message template. We recommend * using HTML format for email clients that render HTML content. You can include links, formatted text, and more in * an HTML message. *

*/ private String htmlPart; /** *

* The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value * to determine how to retrieve and process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation data. *

*/ private String recommenderId; /** *

* The subject line, or title, to use in email messages that are based on the message template. *

*/ private String subject; /** * *

* 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 message body, in plain text format, to use in email messages that are based on the message template. We * recommend using plain text format for email clients that don't render HTML content and clients that are connected * to high-latency networks, such as mobile devices. *

*/ private String textPart; /** *

* * @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 EmailTemplateRequest withDefaultSubstitutions(String defaultSubstitutions) { setDefaultSubstitutions(defaultSubstitutions); return this; } /** *

* * @param htmlPart * The message body, in HTML format, to use in email messages that are based on the message template. We * recommend using HTML format for email clients that render HTML content. You can include links, formatted * text, and more in an HTML message. */ public void setHtmlPart(String htmlPart) { this.htmlPart = htmlPart; } /** *

* * @return The message body, in HTML format, to use in email messages that are based on the message template. We * recommend using HTML format for email clients that render HTML content. You can include links, formatted * text, and more in an HTML message. */ public String getHtmlPart() { return this.htmlPart; } /** *

* * @param htmlPart * The message body, in HTML format, to use in email messages that are based on the message template. We * recommend using HTML format for email clients that render HTML content. You can include links, formatted * text, and more in an HTML message. * @return Returns a reference to this object so that method calls can be chained together. */ public EmailTemplateRequest withHtmlPart(String htmlPart) { setHtmlPart(htmlPart); return this; } /** *

* * @param recommenderId * The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this * value to determine how to retrieve and process data from a recommender model when it sends messages that * use the template, if the template contains message variables for recommendation data. */ public void setRecommenderId(String recommenderId) { this.recommenderId = recommenderId; } /** *

* * @return The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses * this value to determine how to retrieve and process data from a recommender model when it sends messages * that use the template, if the template contains message variables for recommendation data. */ public String getRecommenderId() { return this.recommenderId; } /** *

* * @param recommenderId * The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this * value to determine how to retrieve and process data from a recommender model when it sends messages that * use the template, if the template contains message variables for recommendation data. * @return Returns a reference to this object so that method calls can be chained together. */ public EmailTemplateRequest withRecommenderId(String recommenderId) { setRecommenderId(recommenderId); return this; } /** *

* The subject line, or title, to use in email messages that are based on the message template. *

* * @param subject * The subject line, or title, to use in email messages that are based on the message template. */ public void setSubject(String subject) { this.subject = subject; } /** *

* The subject line, or title, to use in email messages that are based on the message template. *

* * @return The subject line, or title, to use in email messages that are based on the message template. */ public String getSubject() { return this.subject; } /** *

* The subject line, or title, to use in email messages that are based on the message template. *

* * @param subject * The subject line, or title, to use in email messages that are based on the message template. * @return Returns a reference to this object so that method calls can be chained together. */ public EmailTemplateRequest withSubject(String subject) { setSubject(subject); 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 EmailTemplateRequest withTags(java.util.Map tags) { setTags(tags); return this; } /** * Add a single Tags entry * * @see EmailTemplateRequest#withTags * @returns a reference to this object so that method calls can be chained together. */ public EmailTemplateRequest 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 EmailTemplateRequest 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 EmailTemplateRequest withTemplateDescription(String templateDescription) { setTemplateDescription(templateDescription); return this; } /** *

* * @return The message body, in plain text format, to use in email messages that are based on the message template. * We recommend using plain text format for email clients that don't render HTML content and clients that * are connected to high-latency networks, such as mobile devices. */ public String getTextPart() { return this.textPart; } /** *

* * @param textPart * The message body, in plain text format, to use in email messages that are based on the message template. * We recommend using plain text format for email clients that don't render HTML content and clients that are * connected to high-latency networks, such as mobile devices. * @return Returns a reference to this object so that method calls can be chained together. */ public EmailTemplateRequest withTextPart(String textPart) { setTextPart(textPart); 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 (getDefaultSubstitutions() != null) sb.append("DefaultSubstitutions: ").append(getDefaultSubstitutions()).append(","); if (getHtmlPart() != null) sb.append("HtmlPart: ").append(getHtmlPart()).append(","); if (getRecommenderId() != null) sb.append("RecommenderId: ").append(getRecommenderId()).append(","); if (getSubject() != null) sb.append("Subject: ").append(getSubject()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getTemplateDescription() != null) sb.append("TemplateDescription: ").append(getTemplateDescription()).append(","); if (getTextPart() != null) sb.append("TextPart: ").append(getTextPart()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof EmailTemplateRequest == false) return false; EmailTemplateRequest other = (EmailTemplateRequest) obj; if (other.getDefaultSubstitutions() == null ^ this.getDefaultSubstitutions() == null) return false; if (other.getDefaultSubstitutions() != null && other.getDefaultSubstitutions().equals(this.getDefaultSubstitutions()) == false) return false; if (other.getHtmlPart() == null ^ this.getHtmlPart() == null) return false; if (other.getHtmlPart() != null && other.getHtmlPart().equals(this.getHtmlPart()) == false) return false; if (other.getRecommenderId() == null ^ this.getRecommenderId() == null) return false; if (other.getRecommenderId() != null && other.getRecommenderId().equals(this.getRecommenderId()) == false) return false; if (other.getSubject() == null ^ this.getSubject() == null) return false; if (other.getSubject() != null && other.getSubject().equals(this.getSubject()) == 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.getTextPart() == null ^ this.getTextPart() == null) return false; if (other.getTextPart() != null && other.getTextPart().equals(this.getTextPart()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDefaultSubstitutions() == null) ? 0 : getDefaultSubstitutions().hashCode()); hashCode = prime * hashCode + ((getHtmlPart() == null) ? 0 : getHtmlPart().hashCode()); hashCode = prime * hashCode + ((getRecommenderId() == null) ? 0 : getRecommenderId().hashCode()); hashCode = prime * hashCode + ((getSubject() == null) ? 0 : getSubject().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getTemplateDescription() == null) ? 0 : getTemplateDescription().hashCode()); hashCode = prime * hashCode + ((getTextPart() == null) ? 0 : getTextPart().hashCode()); return hashCode; } @Override public EmailTemplateRequest clone() { try { return (EmailTemplateRequest) 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.EmailTemplateRequestMarshaller.getInstance().marshall(this, protocolMarshaller); } }