software.amazon.awssdk.services.pinpoint.model.SMSTemplateResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinpoint Show documentation
Show all versions of pinpoint Show documentation
The AWS Java SDK for Amazon Pinpoint module holds the client classes that are used for communicating
with Amazon Pinpoint Service
/*
* 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.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
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;
/**
*
* Provides information about the content and settings for a message template that can be used in text messages that are
* sent through the SMS channel.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SMSTemplateResponse implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(SMSTemplateResponse::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField BODY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Body")
.getter(getter(SMSTemplateResponse::body)).setter(setter(Builder::body))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Body").build()).build();
private static final SdkField CREATION_DATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CreationDate").getter(getter(SMSTemplateResponse::creationDate)).setter(setter(Builder::creationDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationDate").build()).build();
private static final SdkField DEFAULT_SUBSTITUTIONS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DefaultSubstitutions").getter(getter(SMSTemplateResponse::defaultSubstitutions))
.setter(setter(Builder::defaultSubstitutions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultSubstitutions").build())
.build();
private static final SdkField LAST_MODIFIED_DATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LastModifiedDate").getter(getter(SMSTemplateResponse::lastModifiedDate))
.setter(setter(Builder::lastModifiedDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedDate").build()).build();
private static final SdkField RECOMMENDER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RecommenderId").getter(getter(SMSTemplateResponse::recommenderId))
.setter(setter(Builder::recommenderId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecommenderId").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(SMSTemplateResponse::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(SMSTemplateResponse::templateDescription))
.setter(setter(Builder::templateDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateDescription").build())
.build();
private static final SdkField TEMPLATE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateName").getter(getter(SMSTemplateResponse::templateName)).setter(setter(Builder::templateName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateName").build()).build();
private static final SdkField TEMPLATE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateType").getter(getter(SMSTemplateResponse::templateTypeAsString))
.setter(setter(Builder::templateType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateType").build()).build();
private static final SdkField VERSION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Version")
.getter(getter(SMSTemplateResponse::version)).setter(setter(Builder::version))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Version").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, BODY_FIELD,
CREATION_DATE_FIELD, DEFAULT_SUBSTITUTIONS_FIELD, LAST_MODIFIED_DATE_FIELD, RECOMMENDER_ID_FIELD, TAGS_FIELD,
TEMPLATE_DESCRIPTION_FIELD, TEMPLATE_NAME_FIELD, TEMPLATE_TYPE_FIELD, VERSION_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final String body;
private final String creationDate;
private final String defaultSubstitutions;
private final String lastModifiedDate;
private final String recommenderId;
private final Map tags;
private final String templateDescription;
private final String templateName;
private final String templateType;
private final String version;
private SMSTemplateResponse(BuilderImpl builder) {
this.arn = builder.arn;
this.body = builder.body;
this.creationDate = builder.creationDate;
this.defaultSubstitutions = builder.defaultSubstitutions;
this.lastModifiedDate = builder.lastModifiedDate;
this.recommenderId = builder.recommenderId;
this.tags = builder.tags;
this.templateDescription = builder.templateDescription;
this.templateName = builder.templateName;
this.templateType = builder.templateType;
this.version = builder.version;
}
/**
*
* The Amazon Resource Name (ARN) of the message template.
*
*
* @return The Amazon Resource Name (ARN) of the message template.
*/
public final String arn() {
return arn;
}
/**
*
* The message body that's used in text messages that are based on the message template.
*
*
* @return The message body that's used in text messages that are based on the message template.
*/
public final String body() {
return body;
}
/**
*
* The date, in ISO 8601 format, when the message template was created.
*
*
* @return The date, in ISO 8601 format, when the message template was created.
*/
public final String creationDate() {
return creationDate;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String defaultSubstitutions() {
return defaultSubstitutions;
}
/**
*
* The date, in ISO 8601 format, when the message template was last modified.
*
*
* @return The date, in ISO 8601 format, when the message template was last modified.
*/
public final String lastModifiedDate() {
return lastModifiedDate;
}
/**
*
* The unique identifier for the recommender model that's used by the message template.
*
*
* @return The unique identifier for the recommender model that's used by the message template.
*/
public final String recommenderId() {
return recommenderId;
}
/**
* 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);
}
/**
*
* 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.
*
*
* 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 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.
*/
public final Map tags() {
return tags;
}
/**
*
* The custom description of the message template.
*
*
* @return The custom description of the message template.
*/
public final String templateDescription() {
return templateDescription;
}
/**
*
* The name of the message template.
*
*
* @return The name of the message template.
*/
public final String templateName() {
return templateName;
}
/**
*
* The type of channel that the message template is designed for. For an SMS template, this value is SMS.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #templateType} will
* return {@link TemplateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #templateTypeAsString}.
*
*
* @return The type of channel that the message template is designed for. For an SMS template, this value is SMS.
* @see TemplateType
*/
public final TemplateType templateType() {
return TemplateType.fromValue(templateType);
}
/**
*
* The type of channel that the message template is designed for. For an SMS template, this value is SMS.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #templateType} will
* return {@link TemplateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #templateTypeAsString}.
*
*
* @return The type of channel that the message template is designed for. For an SMS template, this value is SMS.
* @see TemplateType
*/
public final String templateTypeAsString() {
return templateType;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String version() {
return version;
}
@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(arn());
hashCode = 31 * hashCode + Objects.hashCode(body());
hashCode = 31 * hashCode + Objects.hashCode(creationDate());
hashCode = 31 * hashCode + Objects.hashCode(defaultSubstitutions());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedDate());
hashCode = 31 * hashCode + Objects.hashCode(recommenderId());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(templateDescription());
hashCode = 31 * hashCode + Objects.hashCode(templateName());
hashCode = 31 * hashCode + Objects.hashCode(templateTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(version());
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 SMSTemplateResponse)) {
return false;
}
SMSTemplateResponse other = (SMSTemplateResponse) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(body(), other.body())
&& Objects.equals(creationDate(), other.creationDate())
&& Objects.equals(defaultSubstitutions(), other.defaultSubstitutions())
&& Objects.equals(lastModifiedDate(), other.lastModifiedDate())
&& Objects.equals(recommenderId(), other.recommenderId()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(templateDescription(), other.templateDescription())
&& Objects.equals(templateName(), other.templateName())
&& Objects.equals(templateTypeAsString(), other.templateTypeAsString())
&& Objects.equals(version(), other.version());
}
/**
* 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("SMSTemplateResponse").add("Arn", arn()).add("Body", body()).add("CreationDate", creationDate())
.add("DefaultSubstitutions", defaultSubstitutions()).add("LastModifiedDate", lastModifiedDate())
.add("RecommenderId", recommenderId()).add("Tags", hasTags() ? tags() : null)
.add("TemplateDescription", templateDescription()).add("TemplateName", templateName())
.add("TemplateType", templateTypeAsString()).add("Version", version()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Body":
return Optional.ofNullable(clazz.cast(body()));
case "CreationDate":
return Optional.ofNullable(clazz.cast(creationDate()));
case "DefaultSubstitutions":
return Optional.ofNullable(clazz.cast(defaultSubstitutions()));
case "LastModifiedDate":
return Optional.ofNullable(clazz.cast(lastModifiedDate()));
case "RecommenderId":
return Optional.ofNullable(clazz.cast(recommenderId()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "TemplateDescription":
return Optional.ofNullable(clazz.cast(templateDescription()));
case "TemplateName":
return Optional.ofNullable(clazz.cast(templateName()));
case "TemplateType":
return Optional.ofNullable(clazz.cast(templateTypeAsString()));
case "Version":
return Optional.ofNullable(clazz.cast(version()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SMSTemplateResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the message template.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the message template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The message body that's used in text messages that are based on the message template.
*
*
* @param body
* The message body that's used in text messages that are based on the message template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder body(String body);
/**
*
* The date, in ISO 8601 format, when the message template was created.
*
*
* @param creationDate
* The date, in ISO 8601 format, when the message template was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationDate(String creationDate);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultSubstitutions(String defaultSubstitutions);
/**
*
* The date, in ISO 8601 format, when the message template was last modified.
*
*
* @param lastModifiedDate
* The date, in ISO 8601 format, when the message template was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedDate(String lastModifiedDate);
/**
*
* The unique identifier for the recommender model that's used by the message template.
*
*
* @param recommenderId
* The unique identifier for the recommender model that's used by the message template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recommenderId(String recommenderId);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The custom description of the message template.
*
*
* @param templateDescription
* The 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 name of the message template.
*
*
* @param templateName
* The name of the message template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateName(String templateName);
/**
*
* The type of channel that the message template is designed for. For an SMS template, this value is SMS.
*
*
* @param templateType
* The type of channel that the message template is designed for. For an SMS template, this value is SMS.
* @see TemplateType
* @return Returns a reference to this object so that method calls can be chained together.
* @see TemplateType
*/
Builder templateType(String templateType);
/**
*
* The type of channel that the message template is designed for. For an SMS template, this value is SMS.
*
*
* @param templateType
* The type of channel that the message template is designed for. For an SMS template, this value is SMS.
* @see TemplateType
* @return Returns a reference to this object so that method calls can be chained together.
* @see TemplateType
*/
Builder templateType(TemplateType templateType);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder version(String version);
}
static final class BuilderImpl implements Builder {
private String arn;
private String body;
private String creationDate;
private String defaultSubstitutions;
private String lastModifiedDate;
private String recommenderId;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String templateDescription;
private String templateName;
private String templateType;
private String version;
private BuilderImpl() {
}
private BuilderImpl(SMSTemplateResponse model) {
arn(model.arn);
body(model.body);
creationDate(model.creationDate);
defaultSubstitutions(model.defaultSubstitutions);
lastModifiedDate(model.lastModifiedDate);
recommenderId(model.recommenderId);
tags(model.tags);
templateDescription(model.templateDescription);
templateName(model.templateName);
templateType(model.templateType);
version(model.version);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
@Transient
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getBody() {
return body;
}
public final void setBody(String body) {
this.body = body;
}
@Override
@Transient
public final Builder body(String body) {
this.body = body;
return this;
}
public final String getCreationDate() {
return creationDate;
}
public final void setCreationDate(String creationDate) {
this.creationDate = creationDate;
}
@Override
@Transient
public final Builder creationDate(String creationDate) {
this.creationDate = creationDate;
return this;
}
public final String getDefaultSubstitutions() {
return defaultSubstitutions;
}
public final void setDefaultSubstitutions(String defaultSubstitutions) {
this.defaultSubstitutions = defaultSubstitutions;
}
@Override
@Transient
public final Builder defaultSubstitutions(String defaultSubstitutions) {
this.defaultSubstitutions = defaultSubstitutions;
return this;
}
public final String getLastModifiedDate() {
return lastModifiedDate;
}
public final void setLastModifiedDate(String lastModifiedDate) {
this.lastModifiedDate = lastModifiedDate;
}
@Override
@Transient
public final Builder lastModifiedDate(String lastModifiedDate) {
this.lastModifiedDate = lastModifiedDate;
return this;
}
public final String getRecommenderId() {
return recommenderId;
}
public final void setRecommenderId(String recommenderId) {
this.recommenderId = recommenderId;
}
@Override
@Transient
public final Builder recommenderId(String recommenderId) {
this.recommenderId = recommenderId;
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
@Transient
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
@Transient
public final Builder templateDescription(String templateDescription) {
this.templateDescription = templateDescription;
return this;
}
public final String getTemplateName() {
return templateName;
}
public final void setTemplateName(String templateName) {
this.templateName = templateName;
}
@Override
@Transient
public final Builder templateName(String templateName) {
this.templateName = templateName;
return this;
}
public final String getTemplateType() {
return templateType;
}
public final void setTemplateType(String templateType) {
this.templateType = templateType;
}
@Override
@Transient
public final Builder templateType(String templateType) {
this.templateType = templateType;
return this;
}
@Override
@Transient
public final Builder templateType(TemplateType templateType) {
this.templateType(templateType == null ? null : templateType.toString());
return this;
}
public final String getVersion() {
return version;
}
public final void setVersion(String version) {
this.version = version;
}
@Override
@Transient
public final Builder version(String version) {
this.version = version;
return this;
}
@Override
public SMSTemplateResponse build() {
return new SMSTemplateResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy