software.amazon.awssdk.services.pinpoint.model.EmailTemplateRequest Maven / Gradle / Ivy
Show all versions of pinpoint Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.pinpoint.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies the content and settings for a message template that can be used in messages that are sent through the
* email channel.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EmailTemplateRequest implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DEFAULT_SUBSTITUTIONS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DefaultSubstitutions").getter(getter(EmailTemplateRequest::defaultSubstitutions))
.setter(setter(Builder::defaultSubstitutions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultSubstitutions").build())
.build();
private static final SdkField HTML_PART_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HtmlPart").getter(getter(EmailTemplateRequest::htmlPart)).setter(setter(Builder::htmlPart))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HtmlPart").build()).build();
private static final SdkField RECOMMENDER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RecommenderId").getter(getter(EmailTemplateRequest::recommenderId))
.setter(setter(Builder::recommenderId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecommenderId").build()).build();
private static final SdkField SUBJECT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Subject")
.getter(getter(EmailTemplateRequest::subject)).setter(setter(Builder::subject))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Subject").build()).build();
private static final SdkField> HEADERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Headers")
.getter(getter(EmailTemplateRequest::headers))
.setter(setter(Builder::headers))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Headers").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MessageHeader::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(EmailTemplateRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField TEMPLATE_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateDescription").getter(getter(EmailTemplateRequest::templateDescription))
.setter(setter(Builder::templateDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateDescription").build())
.build();
private static final SdkField TEXT_PART_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TextPart").getter(getter(EmailTemplateRequest::textPart)).setter(setter(Builder::textPart))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TextPart").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DEFAULT_SUBSTITUTIONS_FIELD,
HTML_PART_FIELD, RECOMMENDER_ID_FIELD, SUBJECT_FIELD, HEADERS_FIELD, TAGS_FIELD, TEMPLATE_DESCRIPTION_FIELD,
TEXT_PART_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("DefaultSubstitutions", DEFAULT_SUBSTITUTIONS_FIELD);
put("HtmlPart", HTML_PART_FIELD);
put("RecommenderId", RECOMMENDER_ID_FIELD);
put("Subject", SUBJECT_FIELD);
put("Headers", HEADERS_FIELD);
put("tags", TAGS_FIELD);
put("TemplateDescription", TEMPLATE_DESCRIPTION_FIELD);
put("TextPart", TEXT_PART_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String defaultSubstitutions;
private final String htmlPart;
private final String recommenderId;
private final String subject;
private final List headers;
private final Map tags;
private final String templateDescription;
private final String textPart;
private EmailTemplateRequest(BuilderImpl builder) {
this.defaultSubstitutions = builder.defaultSubstitutions;
this.htmlPart = builder.htmlPart;
this.recommenderId = builder.recommenderId;
this.subject = builder.subject;
this.headers = builder.headers;
this.tags = builder.tags;
this.templateDescription = builder.templateDescription;
this.textPart = builder.textPart;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String defaultSubstitutions() {
return defaultSubstitutions;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String htmlPart() {
return htmlPart;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String recommenderId() {
return recommenderId;
}
/**
*
* The subject line, or title, to use in email messages that are based on the message template.
*
*
* @return The subject line, or title, to use in email messages that are based on the message template.
*/
public final String subject() {
return subject;
}
/**
* For responses, this returns true if the service returned a value for the Headers property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasHeaders() {
return headers != null && !(headers instanceof SdkAutoConstructList);
}
/**
*
* The list of MessageHeaders for the email. You can have up to 15 Headers.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasHeaders} method.
*
*
* @return The list of MessageHeaders for the email. You can have up to 15 Headers.
*/
public final List headers() {
return headers;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
*
* As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not
* processed and an error code is not returned. To manage tags we recommend using either Tags in the API
* Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
*
*
*
* (Deprecated) 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.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags
* is not processed and an error code is not returned. To manage tags we recommend using either Tags in the
* API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
*/
public final Map tags() {
return tags;
}
/**
*
* A custom description of the message template.
*
*
* @return A custom description of the message template.
*/
public final String templateDescription() {
return templateDescription;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String textPart() {
return textPart;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(defaultSubstitutions());
hashCode = 31 * hashCode + Objects.hashCode(htmlPart());
hashCode = 31 * hashCode + Objects.hashCode(recommenderId());
hashCode = 31 * hashCode + Objects.hashCode(subject());
hashCode = 31 * hashCode + Objects.hashCode(hasHeaders() ? headers() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(templateDescription());
hashCode = 31 * hashCode + Objects.hashCode(textPart());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EmailTemplateRequest)) {
return false;
}
EmailTemplateRequest other = (EmailTemplateRequest) obj;
return Objects.equals(defaultSubstitutions(), other.defaultSubstitutions())
&& Objects.equals(htmlPart(), other.htmlPart()) && Objects.equals(recommenderId(), other.recommenderId())
&& Objects.equals(subject(), other.subject()) && hasHeaders() == other.hasHeaders()
&& Objects.equals(headers(), other.headers()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(templateDescription(), other.templateDescription())
&& Objects.equals(textPart(), other.textPart());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("EmailTemplateRequest").add("DefaultSubstitutions", defaultSubstitutions())
.add("HtmlPart", htmlPart()).add("RecommenderId", recommenderId()).add("Subject", subject())
.add("Headers", hasHeaders() ? headers() : null).add("Tags", hasTags() ? tags() : null)
.add("TemplateDescription", templateDescription()).add("TextPart", textPart()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DefaultSubstitutions":
return Optional.ofNullable(clazz.cast(defaultSubstitutions()));
case "HtmlPart":
return Optional.ofNullable(clazz.cast(htmlPart()));
case "RecommenderId":
return Optional.ofNullable(clazz.cast(recommenderId()));
case "Subject":
return Optional.ofNullable(clazz.cast(subject()));
case "Headers":
return Optional.ofNullable(clazz.cast(headers()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "TemplateDescription":
return Optional.ofNullable(clazz.cast(templateDescription()));
case "TextPart":
return Optional.ofNullable(clazz.cast(textPart()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((EmailTemplateRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultSubstitutions(String defaultSubstitutions);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder htmlPart(String htmlPart);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recommenderId(String recommenderId);
/**
*
* The subject line, or title, to use in email messages that are based on the message template.
*
*
* @param subject
* The subject line, or title, to use in email messages that are based on the message template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subject(String subject);
/**
*
* The list of MessageHeaders for the email. You can have up to 15 Headers.
*
*
* @param headers
* The list of MessageHeaders for the email. You can have up to 15 Headers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder headers(Collection headers);
/**
*
* The list of MessageHeaders for the email. You can have up to 15 Headers.
*
*
* @param headers
* The list of MessageHeaders for the email. You can have up to 15 Headers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder headers(MessageHeader... headers);
/**
*
* The list of MessageHeaders for the email. You can have up to 15 Headers.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.pinpoint.model.MessageHeader.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.pinpoint.model.MessageHeader#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.pinpoint.model.MessageHeader.Builder#build()} is called immediately
* and its result is passed to {@link #headers(List)}.
*
* @param headers
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.pinpoint.model.MessageHeader.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #headers(java.util.Collection)
*/
Builder headers(Consumer... headers);
/**
*
*
* As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is
* not processed and an error code is not returned. To manage tags we recommend using either Tags in the API
* Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
*
*
*
* (Deprecated) 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.
*
*
* @param tags
* As of 22-05-2023 tags has been deprecated for update operations. After this date any value in
* tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the
* API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* A custom description of the message template.
*
*
* @param templateDescription
* A custom description of the message template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateDescription(String templateDescription);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder textPart(String textPart);
}
static final class BuilderImpl implements Builder {
private String defaultSubstitutions;
private String htmlPart;
private String recommenderId;
private String subject;
private List headers = DefaultSdkAutoConstructList.getInstance();
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String templateDescription;
private String textPart;
private BuilderImpl() {
}
private BuilderImpl(EmailTemplateRequest model) {
defaultSubstitutions(model.defaultSubstitutions);
htmlPart(model.htmlPart);
recommenderId(model.recommenderId);
subject(model.subject);
headers(model.headers);
tags(model.tags);
templateDescription(model.templateDescription);
textPart(model.textPart);
}
public final String getDefaultSubstitutions() {
return defaultSubstitutions;
}
public final void setDefaultSubstitutions(String defaultSubstitutions) {
this.defaultSubstitutions = defaultSubstitutions;
}
@Override
public final Builder defaultSubstitutions(String defaultSubstitutions) {
this.defaultSubstitutions = defaultSubstitutions;
return this;
}
public final String getHtmlPart() {
return htmlPart;
}
public final void setHtmlPart(String htmlPart) {
this.htmlPart = htmlPart;
}
@Override
public final Builder htmlPart(String htmlPart) {
this.htmlPart = htmlPart;
return this;
}
public final String getRecommenderId() {
return recommenderId;
}
public final void setRecommenderId(String recommenderId) {
this.recommenderId = recommenderId;
}
@Override
public final Builder recommenderId(String recommenderId) {
this.recommenderId = recommenderId;
return this;
}
public final String getSubject() {
return subject;
}
public final void setSubject(String subject) {
this.subject = subject;
}
@Override
public final Builder subject(String subject) {
this.subject = subject;
return this;
}
public final List getHeaders() {
List result = ListOfMessageHeaderCopier.copyToBuilder(this.headers);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setHeaders(Collection headers) {
this.headers = ListOfMessageHeaderCopier.copyFromBuilder(headers);
}
@Override
public final Builder headers(Collection headers) {
this.headers = ListOfMessageHeaderCopier.copy(headers);
return this;
}
@Override
@SafeVarargs
public final Builder headers(MessageHeader... headers) {
headers(Arrays.asList(headers));
return this;
}
@Override
@SafeVarargs
public final Builder headers(Consumer... headers) {
headers(Stream.of(headers).map(c -> MessageHeader.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = MapOf__stringCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = MapOf__stringCopier.copy(tags);
return this;
}
public final String getTemplateDescription() {
return templateDescription;
}
public final void setTemplateDescription(String templateDescription) {
this.templateDescription = templateDescription;
}
@Override
public final Builder templateDescription(String templateDescription) {
this.templateDescription = templateDescription;
return this;
}
public final String getTextPart() {
return textPart;
}
public final void setTextPart(String textPart) {
this.textPart = textPart;
}
@Override
public final Builder textPart(String textPart) {
this.textPart = textPart;
return this;
}
@Override
public EmailTemplateRequest build() {
return new EmailTemplateRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}