software.amazon.awssdk.services.pinpoint.model.PushNotificationTemplateResponse 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.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.Consumer;
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 messages that are sent
* through a push notification channel.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PushNotificationTemplateResponse implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ADM_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ADM")
.getter(getter(PushNotificationTemplateResponse::adm)).setter(setter(Builder::adm))
.constructor(AndroidPushNotificationTemplate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ADM").build()).build();
private static final SdkField APNS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("APNS")
.getter(getter(PushNotificationTemplateResponse::apns)).setter(setter(Builder::apns))
.constructor(APNSPushNotificationTemplate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("APNS").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(PushNotificationTemplateResponse::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField BAIDU_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Baidu")
.getter(getter(PushNotificationTemplateResponse::baidu)).setter(setter(Builder::baidu))
.constructor(AndroidPushNotificationTemplate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Baidu").build()).build();
private static final SdkField CREATION_DATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CreationDate").getter(getter(PushNotificationTemplateResponse::creationDate))
.setter(setter(Builder::creationDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationDate").build()).build();
private static final SdkField DEFAULT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Default")
.getter(getter(PushNotificationTemplateResponse::defaultValue)).setter(setter(Builder::defaultValue))
.constructor(DefaultPushNotificationTemplate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Default").build()).build();
private static final SdkField DEFAULT_SUBSTITUTIONS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DefaultSubstitutions").getter(getter(PushNotificationTemplateResponse::defaultSubstitutions))
.setter(setter(Builder::defaultSubstitutions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultSubstitutions").build())
.build();
private static final SdkField GCM_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("GCM")
.getter(getter(PushNotificationTemplateResponse::gcm)).setter(setter(Builder::gcm))
.constructor(AndroidPushNotificationTemplate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GCM").build()).build();
private static final SdkField LAST_MODIFIED_DATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LastModifiedDate").getter(getter(PushNotificationTemplateResponse::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(PushNotificationTemplateResponse::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(PushNotificationTemplateResponse::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(PushNotificationTemplateResponse::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(PushNotificationTemplateResponse::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(PushNotificationTemplateResponse::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(PushNotificationTemplateResponse::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(ADM_FIELD, APNS_FIELD,
ARN_FIELD, BAIDU_FIELD, CREATION_DATE_FIELD, DEFAULT_FIELD, DEFAULT_SUBSTITUTIONS_FIELD, GCM_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 AndroidPushNotificationTemplate adm;
private final APNSPushNotificationTemplate apns;
private final String arn;
private final AndroidPushNotificationTemplate baidu;
private final String creationDate;
private final DefaultPushNotificationTemplate defaultValue;
private final String defaultSubstitutions;
private final AndroidPushNotificationTemplate gcm;
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 PushNotificationTemplateResponse(BuilderImpl builder) {
this.adm = builder.adm;
this.apns = builder.apns;
this.arn = builder.arn;
this.baidu = builder.baidu;
this.creationDate = builder.creationDate;
this.defaultValue = builder.defaultValue;
this.defaultSubstitutions = builder.defaultSubstitutions;
this.gcm = builder.gcm;
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 message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides
* the default template for push notification channels (DefaultPushNotificationTemplate).
*
*
* @return The message template that's used for the ADM (Amazon Device Messaging) channel. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
public final AndroidPushNotificationTemplate adm() {
return adm;
}
/**
*
* The message template that's used for the APNs (Apple Push Notification service) channel. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*
*
* @return The message template that's used for the APNs (Apple Push Notification service) channel. This message
* template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
public final APNSPushNotificationTemplate apns() {
return apns;
}
/**
*
* 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 template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the
* default template for push notification channels (DefaultPushNotificationTemplate).
*
*
* @return The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
public final AndroidPushNotificationTemplate baidu() {
return baidu;
}
/**
*
* 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 default message template that's used for push notification channels.
*
*
* @return The default message template that's used for push notification channels.
*/
public final DefaultPushNotificationTemplate defaultValue() {
return defaultValue;
}
/**
*
* 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 message template that's used for the GCM channel, which is used to send notifications through the Firebase
* Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the
* default template for push notification channels (DefaultPushNotificationTemplate).
*
*
* @return The message template that's used for the GCM channel, which is used to send notifications through the
* Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
public final AndroidPushNotificationTemplate gcm() {
return gcm;
}
/**
*
* 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 a push notification template, this value is
* PUSH.
*
*
* 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 a push notification template, this
* value is PUSH.
* @see TemplateType
*/
public final TemplateType templateType() {
return TemplateType.fromValue(templateType);
}
/**
*
* The type of channel that the message template is designed for. For a push notification template, this value is
* PUSH.
*
*
* 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 a push notification template, this
* value is PUSH.
* @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(adm());
hashCode = 31 * hashCode + Objects.hashCode(apns());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(baidu());
hashCode = 31 * hashCode + Objects.hashCode(creationDate());
hashCode = 31 * hashCode + Objects.hashCode(defaultValue());
hashCode = 31 * hashCode + Objects.hashCode(defaultSubstitutions());
hashCode = 31 * hashCode + Objects.hashCode(gcm());
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 PushNotificationTemplateResponse)) {
return false;
}
PushNotificationTemplateResponse other = (PushNotificationTemplateResponse) obj;
return Objects.equals(adm(), other.adm()) && Objects.equals(apns(), other.apns()) && Objects.equals(arn(), other.arn())
&& Objects.equals(baidu(), other.baidu()) && Objects.equals(creationDate(), other.creationDate())
&& Objects.equals(defaultValue(), other.defaultValue())
&& Objects.equals(defaultSubstitutions(), other.defaultSubstitutions()) && Objects.equals(gcm(), other.gcm())
&& 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("PushNotificationTemplateResponse").add("ADM", adm()).add("APNS", apns()).add("Arn", arn())
.add("Baidu", baidu()).add("CreationDate", creationDate()).add("Default", defaultValue())
.add("DefaultSubstitutions", defaultSubstitutions()).add("GCM", gcm())
.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 "ADM":
return Optional.ofNullable(clazz.cast(adm()));
case "APNS":
return Optional.ofNullable(clazz.cast(apns()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Baidu":
return Optional.ofNullable(clazz.cast(baidu()));
case "CreationDate":
return Optional.ofNullable(clazz.cast(creationDate()));
case "Default":
return Optional.ofNullable(clazz.cast(defaultValue()));
case "DefaultSubstitutions":
return Optional.ofNullable(clazz.cast(defaultSubstitutions()));
case "GCM":
return Optional.ofNullable(clazz.cast(gcm()));
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((PushNotificationTemplateResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The message template that's used for the ADM (Amazon Device Messaging) channel. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*
*
* @param adm
* The message template that's used for the ADM (Amazon Device Messaging) channel. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder adm(AndroidPushNotificationTemplate adm);
/**
*
* The message template that's used for the ADM (Amazon Device Messaging) channel. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*
* This is a convenience method that creates an instance of the {@link AndroidPushNotificationTemplate.Builder}
* avoiding the need to create one manually via {@link AndroidPushNotificationTemplate#builder()}.
*
*
* When the {@link Consumer} completes, {@link AndroidPushNotificationTemplate.Builder#build()} is called
* immediately and its result is passed to {@link #adm(AndroidPushNotificationTemplate)}.
*
* @param adm
* a consumer that will call methods on {@link AndroidPushNotificationTemplate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #adm(AndroidPushNotificationTemplate)
*/
default Builder adm(Consumer adm) {
return adm(AndroidPushNotificationTemplate.builder().applyMutation(adm).build());
}
/**
*
* The message template that's used for the APNs (Apple Push Notification service) channel. This message
* template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*
*
* @param apns
* The message template that's used for the APNs (Apple Push Notification service) channel. This message
* template overrides the default template for push notification channels
* (DefaultPushNotificationTemplate).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder apns(APNSPushNotificationTemplate apns);
/**
*
* The message template that's used for the APNs (Apple Push Notification service) channel. This message
* template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*
* This is a convenience method that creates an instance of the {@link APNSPushNotificationTemplate.Builder}
* avoiding the need to create one manually via {@link APNSPushNotificationTemplate#builder()}.
*
*
* When the {@link Consumer} completes, {@link APNSPushNotificationTemplate.Builder#build()} is called
* immediately and its result is passed to {@link #apns(APNSPushNotificationTemplate)}.
*
* @param apns
* a consumer that will call methods on {@link APNSPushNotificationTemplate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #apns(APNSPushNotificationTemplate)
*/
default Builder apns(Consumer apns) {
return apns(APNSPushNotificationTemplate.builder().applyMutation(apns).build());
}
/**
*
* 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 template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides
* the default template for push notification channels (DefaultPushNotificationTemplate).
*
*
* @param baidu
* The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder baidu(AndroidPushNotificationTemplate baidu);
/**
*
* The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides
* the default template for push notification channels (DefaultPushNotificationTemplate).
*
* This is a convenience method that creates an instance of the {@link AndroidPushNotificationTemplate.Builder}
* avoiding the need to create one manually via {@link AndroidPushNotificationTemplate#builder()}.
*
*
* When the {@link Consumer} completes, {@link AndroidPushNotificationTemplate.Builder#build()} is called
* immediately and its result is passed to {@link #baidu(AndroidPushNotificationTemplate)}.
*
* @param baidu
* a consumer that will call methods on {@link AndroidPushNotificationTemplate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #baidu(AndroidPushNotificationTemplate)
*/
default Builder baidu(Consumer baidu) {
return baidu(AndroidPushNotificationTemplate.builder().applyMutation(baidu).build());
}
/**
*
* 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 default message template that's used for push notification channels.
*
*
* @param defaultValue
* The default message template that's used for push notification channels.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultValue(DefaultPushNotificationTemplate defaultValue);
/**
*
* The default message template that's used for push notification channels.
*
* This is a convenience method that creates an instance of the {@link DefaultPushNotificationTemplate.Builder}
* avoiding the need to create one manually via {@link DefaultPushNotificationTemplate#builder()}.
*
*
* When the {@link Consumer} completes, {@link DefaultPushNotificationTemplate.Builder#build()} is called
* immediately and its result is passed to {@link #defaultValue(DefaultPushNotificationTemplate)}.
*
* @param defaultValue
* a consumer that will call methods on {@link DefaultPushNotificationTemplate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #defaultValue(DefaultPushNotificationTemplate)
*/
default Builder defaultValue(Consumer defaultValue) {
return defaultValue(DefaultPushNotificationTemplate.builder().applyMutation(defaultValue).build());
}
/**
*
* 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 message template that's used for the GCM channel, which is used to send notifications through the
* Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*
*
* @param gcm
* The message template that's used for the GCM channel, which is used to send notifications through the
* Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder gcm(AndroidPushNotificationTemplate gcm);
/**
*
* The message template that's used for the GCM channel, which is used to send notifications through the
* Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template
* overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*
* This is a convenience method that creates an instance of the {@link AndroidPushNotificationTemplate.Builder}
* avoiding the need to create one manually via {@link AndroidPushNotificationTemplate#builder()}.
*
*
* When the {@link Consumer} completes, {@link AndroidPushNotificationTemplate.Builder#build()} is called
* immediately and its result is passed to {@link #gcm(AndroidPushNotificationTemplate)}.
*
* @param gcm
* a consumer that will call methods on {@link AndroidPushNotificationTemplate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #gcm(AndroidPushNotificationTemplate)
*/
default Builder gcm(Consumer gcm) {
return gcm(AndroidPushNotificationTemplate.builder().applyMutation(gcm).build());
}
/**
*
* 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 a push notification template, this value
* is PUSH.
*
*
* @param templateType
* The type of channel that the message template is designed for. For a push notification template, this
* value is PUSH.
* @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 a push notification template, this value
* is PUSH.
*
*
* @param templateType
* The type of channel that the message template is designed for. For a push notification template, this
* value is PUSH.
* @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 AndroidPushNotificationTemplate adm;
private APNSPushNotificationTemplate apns;
private String arn;
private AndroidPushNotificationTemplate baidu;
private String creationDate;
private DefaultPushNotificationTemplate defaultValue;
private String defaultSubstitutions;
private AndroidPushNotificationTemplate gcm;
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(PushNotificationTemplateResponse model) {
adm(model.adm);
apns(model.apns);
arn(model.arn);
baidu(model.baidu);
creationDate(model.creationDate);
defaultValue(model.defaultValue);
defaultSubstitutions(model.defaultSubstitutions);
gcm(model.gcm);
lastModifiedDate(model.lastModifiedDate);
recommenderId(model.recommenderId);
tags(model.tags);
templateDescription(model.templateDescription);
templateName(model.templateName);
templateType(model.templateType);
version(model.version);
}
public final AndroidPushNotificationTemplate.Builder getAdm() {
return adm != null ? adm.toBuilder() : null;
}
public final void setAdm(AndroidPushNotificationTemplate.BuilderImpl adm) {
this.adm = adm != null ? adm.build() : null;
}
@Override
public final Builder adm(AndroidPushNotificationTemplate adm) {
this.adm = adm;
return this;
}
public final APNSPushNotificationTemplate.Builder getApns() {
return apns != null ? apns.toBuilder() : null;
}
public final void setApns(APNSPushNotificationTemplate.BuilderImpl apns) {
this.apns = apns != null ? apns.build() : null;
}
@Override
public final Builder apns(APNSPushNotificationTemplate apns) {
this.apns = apns;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final AndroidPushNotificationTemplate.Builder getBaidu() {
return baidu != null ? baidu.toBuilder() : null;
}
public final void setBaidu(AndroidPushNotificationTemplate.BuilderImpl baidu) {
this.baidu = baidu != null ? baidu.build() : null;
}
@Override
public final Builder baidu(AndroidPushNotificationTemplate baidu) {
this.baidu = baidu;
return this;
}
public final String getCreationDate() {
return creationDate;
}
public final void setCreationDate(String creationDate) {
this.creationDate = creationDate;
}
@Override
public final Builder creationDate(String creationDate) {
this.creationDate = creationDate;
return this;
}
public final DefaultPushNotificationTemplate.Builder getDefaultValue() {
return defaultValue != null ? defaultValue.toBuilder() : null;
}
public final void setDefaultValue(DefaultPushNotificationTemplate.BuilderImpl defaultValue) {
this.defaultValue = defaultValue != null ? defaultValue.build() : null;
}
@Override
public final Builder defaultValue(DefaultPushNotificationTemplate defaultValue) {
this.defaultValue = defaultValue;
return this;
}
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 AndroidPushNotificationTemplate.Builder getGcm() {
return gcm != null ? gcm.toBuilder() : null;
}
public final void setGcm(AndroidPushNotificationTemplate.BuilderImpl gcm) {
this.gcm = gcm != null ? gcm.build() : null;
}
@Override
public final Builder gcm(AndroidPushNotificationTemplate gcm) {
this.gcm = gcm;
return this;
}
public final String getLastModifiedDate() {
return lastModifiedDate;
}
public final void setLastModifiedDate(String lastModifiedDate) {
this.lastModifiedDate = lastModifiedDate;
}
@Override
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
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
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 getTemplateName() {
return templateName;
}
public final void setTemplateName(String templateName) {
this.templateName = templateName;
}
@Override
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
public final Builder templateType(String templateType) {
this.templateType = templateType;
return this;
}
@Override
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
public final Builder version(String version) {
this.version = version;
return this;
}
@Override
public PushNotificationTemplateResponse build() {
return new PushNotificationTemplateResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}