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

Class PushNotificationTemplateRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.PushNotificationTemplateRequest

All Implemented Interfaces:

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

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

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PushNotificationTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
AndroidPushNotificationTemplate	adm()	The message template to use for the ADM (Amazon Device Messaging) channel.
APNSPushNotificationTemplate	apns()	The message template to use for the APNs (Apple Push Notification service) channel.
AndroidPushNotificationTemplate	baidu()	The message template to use for the Baidu (Baidu Cloud Push) channel.
static PushNotificationTemplateRequest.Builder	builder()
String	defaultSubstitutions()	A JSON object that specifies the default values to use for message variables in the message template.
DefaultPushNotificationTemplate	defaultValue()	The default message template to use for push notification channels.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
AndroidPushNotificationTemplate	gcm()	The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	recommenderId()	The unique identifier for the recommender model to use for the message template.
List<SdkField<?>>	sdkFields()
static Class<? extends PushNotificationTemplateRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()
String	templateDescription()	A custom description of the message template.
PushNotificationTemplateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

adm

public final AndroidPushNotificationTemplate adm()

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

apns

public final APNSPushNotificationTemplate apns()

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

baidu

public final AndroidPushNotificationTemplate baidu()

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

defaultValue

public final DefaultPushNotificationTemplate defaultValue()

The default message template to use for push notification channels.

Returns:

The default message template to use for push notification channels.

defaultSubstitutions

public final String 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.

Returns:

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.

gcm

public final AndroidPushNotificationTemplate gcm()

The message template to use 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).

Returns:

The message template to use 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).

recommenderId

public final String 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.

Returns:

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.

hasTags

public final boolean hasTags()

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 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.

tags

public final Map<String,String> 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.

(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 hasTags() method.

Returns:

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.

templateDescription

public final String templateDescription()

A custom description of the message template.

Returns:

A custom description of the message template.

toBuilder

public PushNotificationTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PushNotificationTemplateRequest.Builder,PushNotificationTemplateRequest>

builder

public static PushNotificationTemplateRequest.Builder builder()

serializableBuilderClass

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