software.amazon.awssdk.services.pinpoint.model

Class EmailTemplateRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.EmailTemplateRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EmailTemplateRequest.Builder,EmailTemplateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class EmailTemplateRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EmailTemplateRequest.Builder,EmailTemplateRequest>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EmailTemplateRequest.Builder

Method Summary

Modifier and Type	Method and Description
static EmailTemplateRequest.Builder	builder()
String	defaultSubstitutions() A JSON object that specifies the default values to use for message variables in the message template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	htmlPart() The message body, in HTML format, to use in email messages that are based on the message template.
String	recommenderId() The unique identifier for the recommender model to use for the message template.
List<SdkField<?>>	sdkFields()
static Class<? extends EmailTemplateRequest.Builder>	serializableBuilderClass()
String	subject() The subject line, or title, to use in email messages that are based on the message template.
Map<String,String>	tags() A string-to-string map of key-value pairs that defines the tags to associate with the message template.
String	templateDescription() A custom description of the message template.
String	textPart() The message body, in plain text format, to use in email messages that are based on the message template.
EmailTemplateRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

defaultSubstitutions

public final String 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.

Returns:

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.

htmlPart

public final String 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.

Returns:

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.

recommenderId

public final String 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.

Returns:

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.

subject

public final String subject()

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

Returns:

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

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

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.

templateDescription

public final String templateDescription()

A custom description of the message template.

Returns:

A custom description of the message template.

textPart

public final String 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.

Returns:

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.

toBuilder

public EmailTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EmailTemplateRequest.Builder,EmailTemplateRequest>

builder

public static EmailTemplateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends EmailTemplateRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo