PushNotificationTemplateRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.PushNotificationTemplateRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PushNotificationTemplateRequest
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PushNotificationTemplateRequest()

Constructors
Constructor and Description
`PushNotificationTemplateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PushNotificationTemplateRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`PushNotificationTemplateRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`PushNotificationTemplateRequest`	`clone()`
`boolean`	`equals(Object obj)`
`AndroidPushNotificationTemplate`	`getADM()` The message template to use for the ADM (Amazon Device Messaging) channel.
`APNSPushNotificationTemplate`	`getAPNS()` The message template to use for the APNs (Apple Push Notification service) channel.
`AndroidPushNotificationTemplate`	`getBaidu()` The message template to use for the Baidu (Baidu Cloud Push) channel.
`DefaultPushNotificationTemplate`	`getDefault()` The default message template to use for push notification channels.
`String`	`getDefaultSubstitutions()` A JSON object that specifies the default values to use for message variables in the message template.
`AndroidPushNotificationTemplate`	`getGCM()` 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.
`String`	`getRecommenderId()` The unique identifier for the recommender model to use for the message template.
`Map<String,String>`	`getTags()`
`String`	`getTemplateDescription()` A custom description of the message template.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setADM(AndroidPushNotificationTemplate aDM)` The message template to use for the ADM (Amazon Device Messaging) channel.
`void`	`setAPNS(APNSPushNotificationTemplate aPNS)` The message template to use for the APNs (Apple Push Notification service) channel.
`void`	`setBaidu(AndroidPushNotificationTemplate baidu)` The message template to use for the Baidu (Baidu Cloud Push) channel.
`void`	`setDefault(DefaultPushNotificationTemplate defaultValue)` The default message template to use for push notification channels.
`void`	`setDefaultSubstitutions(String defaultSubstitutions)` A JSON object that specifies the default values to use for message variables in the message template.
`void`	`setGCM(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.
`void`	`setRecommenderId(String recommenderId)` The unique identifier for the recommender model to use for the message template.
`void`	`setTags(Map<String,String> tags)`
`void`	`setTemplateDescription(String templateDescription)` A custom description of the message template.
`String`	`toString()` Returns a string representation of this object.
`PushNotificationTemplateRequest`	`withADM(AndroidPushNotificationTemplate aDM)` The message template to use for the ADM (Amazon Device Messaging) channel.
`PushNotificationTemplateRequest`	`withAPNS(APNSPushNotificationTemplate aPNS)` The message template to use for the APNs (Apple Push Notification service) channel.
`PushNotificationTemplateRequest`	`withBaidu(AndroidPushNotificationTemplate baidu)` The message template to use for the Baidu (Baidu Cloud Push) channel.
`PushNotificationTemplateRequest`	`withDefault(DefaultPushNotificationTemplate defaultValue)` The default message template to use for push notification channels.
`PushNotificationTemplateRequest`	`withDefaultSubstitutions(String defaultSubstitutions)` A JSON object that specifies the default values to use for message variables in the message template.
`PushNotificationTemplateRequest`	`withGCM(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.
`PushNotificationTemplateRequest`	`withRecommenderId(String recommenderId)` The unique identifier for the recommender model to use for the message template.
`PushNotificationTemplateRequest`	`withTags(Map<String,String> tags)`
`PushNotificationTemplateRequest`	`withTemplateDescription(String templateDescription)` A custom description of the message template.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PushNotificationTemplateRequest
```
public PushNotificationTemplateRequest()
```
- Method Detail
  - setADM
```
public void setADM(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).
    
    Parameters:
    
    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).
  - getADM
```
public AndroidPushNotificationTemplate getADM()
```
    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).
  - withADM
```
public PushNotificationTemplateRequest withADM(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAPNS
```
public void setAPNS(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).
    
    Parameters:
    
    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).
  - getAPNS
```
public APNSPushNotificationTemplate getAPNS()
```
    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).
  - withAPNS
```
public PushNotificationTemplateRequest withAPNS(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBaidu
```
public void setBaidu(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).
    
    Parameters:
    
    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).
  - getBaidu
```
public AndroidPushNotificationTemplate getBaidu()
```
    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).
  - withBaidu
```
public PushNotificationTemplateRequest withBaidu(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefault
```
public void setDefault(DefaultPushNotificationTemplate defaultValue)
```
    The default message template to use for push notification channels.
    
    Parameters:
    
    defaultValue - The default message template to use for push notification channels.
  - getDefault
```
public DefaultPushNotificationTemplate getDefault()
```
    The default message template to use for push notification channels.
    
    Returns:
    
    The default message template to use for push notification channels.
  - withDefault
```
public PushNotificationTemplateRequest withDefault(DefaultPushNotificationTemplate defaultValue)
```
    The default message template to use for push notification channels.
    
    Parameters:
    
    defaultValue - The default message template to use for push notification channels.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultSubstitutions
```
public void setDefaultSubstitutions(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.
    
    Parameters:
    
    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.
  - getDefaultSubstitutions
```
public String getDefaultSubstitutions()
```
    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.
  - withDefaultSubstitutions
```
public PushNotificationTemplateRequest withDefaultSubstitutions(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGCM
```
public void setGCM(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).
    
    Parameters:
    
    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).
  - getGCM
```
public AndroidPushNotificationTemplate getGCM()
```
    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).
  - withGCM
```
public PushNotificationTemplateRequest withGCM(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecommenderId
```
public void setRecommenderId(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.
    
    Parameters:
    
    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.
  - getRecommenderId
```
public String getRecommenderId()
```
    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.
  - withRecommenderId
```
public PushNotificationTemplateRequest withRecommenderId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    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.
    
    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.
  - setTags
```
public void setTags(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.
    
    Parameters:
    
    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.
  - withTags
```
public PushNotificationTemplateRequest withTags(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public PushNotificationTemplateRequest addTagsEntry(String key,
                                                    String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public PushNotificationTemplateRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateDescription
```
public void setTemplateDescription(String templateDescription)
```
    A custom description of the message template.
    
    Parameters:
    
    templateDescription - A custom description of the message template.
  - getTemplateDescription
```
public String getTemplateDescription()
```
    A custom description of the message template.
    
    Returns:
    
    A custom description of the message template.
  - withTemplateDescription
```
public PushNotificationTemplateRequest withTemplateDescription(String templateDescription)
```
    A custom description of the message template.
    
    Parameters:
    
    templateDescription - A custom description of the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PushNotificationTemplateRequest clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class PushNotificationTemplateRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PushNotificationTemplateRequest

Method Detail

setADM

getADM

withADM

setAPNS

getAPNS

withAPNS

setBaidu

getBaidu

withBaidu

setDefault

getDefault

withDefault

setDefaultSubstitutions

getDefaultSubstitutions

withDefaultSubstitutions

setGCM

getGCM

withGCM

setRecommenderId

getRecommenderId

withRecommenderId

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setTemplateDescription

getTemplateDescription

withTemplateDescription

toString

equals

hashCode

clone

marshall