Package software.amazon.awssdk.services.pinpoint.model

Class Template

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.Template

All Implemented Interfaces:

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

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

Specifies the name and version of the message template to use for the message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Template.Builder

Method Summary

Modifier and Type	Method	Description
static Template.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the message template to use for the message.
List<SdkField<?>>	sdkFields()
static Class<? extends Template.Builder>	serializableBuilderClass()
Template.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	version()	The unique identifier for the version of the message template to use for the message.

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

name

public final String name()

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Returns:

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

version

public final String version()

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Returns:

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

toBuilder

public Template.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Template.Builder,Template>

builder

public static Template.Builder builder()

serializableBuilderClass

public static Class<? extends Template.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