com.amazonaws.services.simpleemailv2.model.Template Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sesv2 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.simpleemailv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An object that defines the email template to use for an email message, and the values to use for any message
* variables in that template. An email template is a type of message template that contains content that you
* want to define, save, and reuse in email messages that you send.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Template implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the template. You will refer to this name when you send email using the
* SendTemplatedEmail or SendBulkTemplatedEmail operations.
*
*/
private String templateName;
/**
*
* The Amazon Resource Name (ARN) of the template.
*
*/
private String templateArn;
/**
*
* An object that defines the values to use for message variables in the template. This object is a set of key-value
* pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for
* that variable.
*
*/
private String templateData;
/**
*
* The list of message headers that will be added to the email message.
*
*/
private java.util.List headers;
/**
*
* The name of the template. You will refer to this name when you send email using the
* SendTemplatedEmail or SendBulkTemplatedEmail operations.
*
*
* @param templateName
* The name of the template. You will refer to this name when you send email using the
* SendTemplatedEmail or SendBulkTemplatedEmail operations.
*/
public void setTemplateName(String templateName) {
this.templateName = templateName;
}
/**
*
* The name of the template. You will refer to this name when you send email using the
* SendTemplatedEmail or SendBulkTemplatedEmail operations.
*
*
* @return The name of the template. You will refer to this name when you send email using the
* SendTemplatedEmail or SendBulkTemplatedEmail operations.
*/
public String getTemplateName() {
return this.templateName;
}
/**
*
* The name of the template. You will refer to this name when you send email using the
* SendTemplatedEmail or SendBulkTemplatedEmail operations.
*
*
* @param templateName
* The name of the template. You will refer to this name when you send email using the
* SendTemplatedEmail or SendBulkTemplatedEmail operations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withTemplateName(String templateName) {
setTemplateName(templateName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the template.
*
*
* @param templateArn
* The Amazon Resource Name (ARN) of the template.
*/
public void setTemplateArn(String templateArn) {
this.templateArn = templateArn;
}
/**
*
* The Amazon Resource Name (ARN) of the template.
*
*
* @return The Amazon Resource Name (ARN) of the template.
*/
public String getTemplateArn() {
return this.templateArn;
}
/**
*
* The Amazon Resource Name (ARN) of the template.
*
*
* @param templateArn
* The Amazon Resource Name (ARN) of the template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withTemplateArn(String templateArn) {
setTemplateArn(templateArn);
return this;
}
/**
*
* An object that defines the values to use for message variables in the template. This object is a set of key-value
* pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for
* that variable.
*
*
* @param templateData
* An object that defines the values to use for message variables in the template. This object is a set of
* key-value pairs. Each key defines a message variable in the template. The corresponding value defines the
* value to use for that variable.
*/
public void setTemplateData(String templateData) {
this.templateData = templateData;
}
/**
*
* An object that defines the values to use for message variables in the template. This object is a set of key-value
* pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for
* that variable.
*
*
* @return An object that defines the values to use for message variables in the template. This object is a set of
* key-value pairs. Each key defines a message variable in the template. The corresponding value defines the
* value to use for that variable.
*/
public String getTemplateData() {
return this.templateData;
}
/**
*
* An object that defines the values to use for message variables in the template. This object is a set of key-value
* pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for
* that variable.
*
*
* @param templateData
* An object that defines the values to use for message variables in the template. This object is a set of
* key-value pairs. Each key defines a message variable in the template. The corresponding value defines the
* value to use for that variable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withTemplateData(String templateData) {
setTemplateData(templateData);
return this;
}
/**
*
* The list of message headers that will be added to the email message.
*
*
* @return The list of message headers that will be added to the email message.
*/
public java.util.List getHeaders() {
return headers;
}
/**
*
* The list of message headers that will be added to the email message.
*
*
* @param headers
* The list of message headers that will be added to the email message.
*/
public void setHeaders(java.util.Collection headers) {
if (headers == null) {
this.headers = null;
return;
}
this.headers = new java.util.ArrayList(headers);
}
/**
*
* The list of message headers that will be added to the email message.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setHeaders(java.util.Collection)} or {@link #withHeaders(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param headers
* The list of message headers that will be added to the email message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withHeaders(MessageHeader... headers) {
if (this.headers == null) {
setHeaders(new java.util.ArrayList(headers.length));
}
for (MessageHeader ele : headers) {
this.headers.add(ele);
}
return this;
}
/**
*
* The list of message headers that will be added to the email message.
*
*
* @param headers
* The list of message headers that will be added to the email message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withHeaders(java.util.Collection headers) {
setHeaders(headers);
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 (getTemplateName() != null)
sb.append("TemplateName: ").append(getTemplateName()).append(",");
if (getTemplateArn() != null)
sb.append("TemplateArn: ").append(getTemplateArn()).append(",");
if (getTemplateData() != null)
sb.append("TemplateData: ").append(getTemplateData()).append(",");
if (getHeaders() != null)
sb.append("Headers: ").append(getHeaders());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Template == false)
return false;
Template other = (Template) obj;
if (other.getTemplateName() == null ^ this.getTemplateName() == null)
return false;
if (other.getTemplateName() != null && other.getTemplateName().equals(this.getTemplateName()) == false)
return false;
if (other.getTemplateArn() == null ^ this.getTemplateArn() == null)
return false;
if (other.getTemplateArn() != null && other.getTemplateArn().equals(this.getTemplateArn()) == false)
return false;
if (other.getTemplateData() == null ^ this.getTemplateData() == null)
return false;
if (other.getTemplateData() != null && other.getTemplateData().equals(this.getTemplateData()) == false)
return false;
if (other.getHeaders() == null ^ this.getHeaders() == null)
return false;
if (other.getHeaders() != null && other.getHeaders().equals(this.getHeaders()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTemplateName() == null) ? 0 : getTemplateName().hashCode());
hashCode = prime * hashCode + ((getTemplateArn() == null) ? 0 : getTemplateArn().hashCode());
hashCode = prime * hashCode + ((getTemplateData() == null) ? 0 : getTemplateData().hashCode());
hashCode = prime * hashCode + ((getHeaders() == null) ? 0 : getHeaders().hashCode());
return hashCode;
}
@Override
public Template clone() {
try {
return (Template) 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.simpleemailv2.model.transform.TemplateMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}