Template (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simpleemailv2.model.Template

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Template
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Template()

Constructors
Constructor and Description
`Template()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Template`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getTemplateArn()` The Amazon Resource Name (ARN) of the template.
`String`	`getTemplateData()` An object that defines the values to use for message variables in the template.
`String`	`getTemplateName()` The name of the template.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setTemplateArn(String templateArn)` The Amazon Resource Name (ARN) of the template.
`void`	`setTemplateData(String templateData)` An object that defines the values to use for message variables in the template.
`void`	`setTemplateName(String templateName)` The name of the template.
`String`	`toString()` Returns a string representation of this object.
`Template`	`withTemplateArn(String templateArn)` The Amazon Resource Name (ARN) of the template.
`Template`	`withTemplateData(String templateData)` An object that defines the values to use for message variables in the template.
`Template`	`withTemplateName(String templateName)` The name of the template.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Template
```
public Template()
```
- Method Detail
  - setTemplateName
```
public void setTemplateName(String templateName)
```
    The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
    
    Parameters:
    
    templateName - The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
  - getTemplateName
```
public String getTemplateName()
```
    The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
    
    Returns:
    
    The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
  - withTemplateName
```
public Template withTemplateName(String templateName)
```
    The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
    
    Parameters:
    
    templateName - The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateArn
```
public void setTemplateArn(String templateArn)
```
    The Amazon Resource Name (ARN) of the template.
    
    Parameters:
    
    templateArn - The Amazon Resource Name (ARN) of the template.
  - getTemplateArn
```
public String getTemplateArn()
```
    The Amazon Resource Name (ARN) of the template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the template.
  - withTemplateArn
```
public Template withTemplateArn(String templateArn)
```
    The Amazon Resource Name (ARN) of the template.
    
    Parameters:
    
    templateArn - The Amazon Resource Name (ARN) of the template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateData
```
public void setTemplateData(String 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.
    
    Parameters:
    
    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.
  - getTemplateData
```
public String getTemplateData()
```
    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.
    
    Returns:
    
    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.
  - withTemplateData
```
public Template withTemplateData(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Template clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Template

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Template

Method Detail

setTemplateName

getTemplateName

withTemplateName

setTemplateArn

getTemplateArn

withTemplateArn

setTemplateData

getTemplateData

withTemplateData

toString

equals

hashCode

clone

marshall