EmailTemplateResponse (AWS Java SDK :: Services :: Amazon Pinpoint 2.16.29 API)

java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.EmailTemplateResponse

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EmailTemplateResponse.Builder,EmailTemplateResponse>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class EmailTemplateResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EmailTemplateResponse.Builder,EmailTemplateResponse>
```
Provides information about 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 EmailTemplateResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EmailTemplateResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the message template.
`static EmailTemplateResponse.Builder`	`builder()`
`String`	`creationDate()` The date, in ISO 8601 format, when the message template was created.
`String`	`defaultSubstitutions()` The JSON object that specifies the default values that are used 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, that's used in email messages that are based on the message template.
`String`	`lastModifiedDate()` The date, in ISO 8601 format, when the message template was last modified.
`String`	`recommenderId()` The unique identifier for the recommender model that's used by the message template.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EmailTemplateResponse.Builder>`	`serializableBuilderClass()`
`String`	`subject()` The subject line, or title, that's used in email messages that are based on the message template.
`Map<String,String>`	`tags()` A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.
`String`	`templateDescription()` The custom description of the message template.
`String`	`templateName()` The name of the message template.
`TemplateType`	`templateType()` The type of channel that the message template is designed for.
`String`	`templateTypeAsString()` The type of channel that the message template is designed for.
`String`	`textPart()` The message body, in plain text format, that's used in email messages that are based on the message template.
`EmailTemplateResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

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
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the message template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the message template.
  - creationDate
```
public final String creationDate()
```
    The date, in ISO 8601 format, when the message template was created.
    
    Returns:
    
    The date, in ISO 8601 format, when the message template was created.
  - defaultSubstitutions
```
public final String defaultSubstitutions()
```
    The JSON object that specifies the default values that are used 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.
    
    Returns:
    
    The JSON object that specifies the default values that are used 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.
  - htmlPart
```
public final String htmlPart()
```
    The message body, in HTML format, that's used in email messages that are based on the message template.
    
    Returns:
    
    The message body, in HTML format, that's used in email messages that are based on the message template.
  - lastModifiedDate
```
public final String lastModifiedDate()
```
    The date, in ISO 8601 format, when the message template was last modified.
    
    Returns:
    
    The date, in ISO 8601 format, when the message template was last modified.
  - recommenderId
```
public final String recommenderId()
```
    The unique identifier for the recommender model that's used by the message template.
    
    Returns:
    
    The unique identifier for the recommender model that's used by the message template.
  - subject
```
public final String subject()
```
    The subject line, or title, that's used in email messages that are based on the message template.
    
    Returns:
    
    The subject line, or title, that's used 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 identifies the tags that are associated 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 identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
  - templateDescription
```
public final String templateDescription()
```
    The custom description of the message template.
    
    Returns:
    
    The custom description of the message template.
  - templateName
```
public final String templateName()
```
    The name of the message template.
    
    Returns:
    
    The name of the message template.
  - templateType
```
public final TemplateType templateType()
```
    The type of channel that the message template is designed for. For an email template, this value is EMAIL.
    
    If the service returns an enum value that is not available in the current SDK version, templateType will return TemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().
    
    Returns:
    
    The type of channel that the message template is designed for. For an email template, this value is EMAIL.
    
    See Also:
    
    TemplateType
  - templateTypeAsString
```
public final String templateTypeAsString()
```
    The type of channel that the message template is designed for. For an email template, this value is EMAIL.
    
    If the service returns an enum value that is not available in the current SDK version, templateType will return TemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().
    
    Returns:
    
    The type of channel that the message template is designed for. For an email template, this value is EMAIL.
    
    See Also:
    
    TemplateType
  - textPart
```
public final String textPart()
```
    The message body, in plain text format, that's used in email messages that are based on the message template.
    
    Returns:
    
    The message body, in plain text format, that's used in email messages that are based on the message template.
  - version
```
public final String version()
```
    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
    
    Returns:
    
    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
  - toBuilder
```
public EmailTemplateResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EmailTemplateResponse.Builder,EmailTemplateResponse>
  - builder
```
public static EmailTemplateResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EmailTemplateResponse.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

Class EmailTemplateResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

creationDate

defaultSubstitutions

htmlPart

lastModifiedDate

recommenderId

subject

hasTags

tags

templateDescription

templateName

templateType

templateTypeAsString

textPart

version

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields