Interface PushNotificationTemplateRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PushNotificationTemplateRequest.Builder,PushNotificationTemplateRequest>, SdkBuilder<PushNotificationTemplateRequest.Builder,PushNotificationTemplateRequest>, SdkPojo

Enclosing class:

PushNotificationTemplateRequest

@Mutable
@NotThreadSafe
public static interface PushNotificationTemplateRequest.Builder
extends SdkPojo, CopyableBuilder<PushNotificationTemplateRequest.Builder,PushNotificationTemplateRequest>

Method Summary

Modifier and Type	Method	Description
default PushNotificationTemplateRequest.Builder	adm(Consumer<AndroidPushNotificationTemplate.Builder> adm)	The message template to use for the ADM (Amazon Device Messaging) channel.
PushNotificationTemplateRequest.Builder	adm(AndroidPushNotificationTemplate adm)	The message template to use for the ADM (Amazon Device Messaging) channel.
default PushNotificationTemplateRequest.Builder	apns(Consumer<APNSPushNotificationTemplate.Builder> apns)	The message template to use for the APNs (Apple Push Notification service) channel.
PushNotificationTemplateRequest.Builder	apns(APNSPushNotificationTemplate apns)	The message template to use for the APNs (Apple Push Notification service) channel.
default PushNotificationTemplateRequest.Builder	baidu(Consumer<AndroidPushNotificationTemplate.Builder> baidu)	The message template to use for the Baidu (Baidu Cloud Push) channel.
PushNotificationTemplateRequest.Builder	baidu(AndroidPushNotificationTemplate baidu)	The message template to use for the Baidu (Baidu Cloud Push) channel.
PushNotificationTemplateRequest.Builder	defaultSubstitutions(String defaultSubstitutions)	A JSON object that specifies the default values to use for message variables in the message template.
default PushNotificationTemplateRequest.Builder	defaultValue(Consumer<DefaultPushNotificationTemplate.Builder> defaultValue)	The default message template to use for push notification channels.
PushNotificationTemplateRequest.Builder	defaultValue(DefaultPushNotificationTemplate defaultValue)	The default message template to use for push notification channels.
default PushNotificationTemplateRequest.Builder	gcm(Consumer<AndroidPushNotificationTemplate.Builder> 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.Builder	gcm(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.Builder	recommenderId(String recommenderId)	The unique identifier for the recommender model to use for the message template.
PushNotificationTemplateRequest.Builder	tags(Map<String,String> tags)
PushNotificationTemplateRequest.Builder	templateDescription(String templateDescription)	A custom description of the message template.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

adm

PushNotificationTemplateRequest.Builder adm(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.

adm

default PushNotificationTemplateRequest.Builder adm(Consumer<AndroidPushNotificationTemplate.Builder> 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).

This is a convenience method that creates an instance of the AndroidPushNotificationTemplate.Builder avoiding the need to create one manually via AndroidPushNotificationTemplate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to adm(AndroidPushNotificationTemplate).

Parameters:

adm - a consumer that will call methods on AndroidPushNotificationTemplate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• adm(AndroidPushNotificationTemplate)

apns

PushNotificationTemplateRequest.Builder apns(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.

apns

default PushNotificationTemplateRequest.Builder apns(Consumer<APNSPushNotificationTemplate.Builder> 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).

This is a convenience method that creates an instance of the APNSPushNotificationTemplate.Builder avoiding the need to create one manually via APNSPushNotificationTemplate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to apns(APNSPushNotificationTemplate).

Parameters:

apns - a consumer that will call methods on APNSPushNotificationTemplate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• apns(APNSPushNotificationTemplate)

baidu

PushNotificationTemplateRequest.Builder baidu(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.

baidu

default PushNotificationTemplateRequest.Builder baidu(Consumer<AndroidPushNotificationTemplate.Builder> 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).

This is a convenience method that creates an instance of the AndroidPushNotificationTemplate.Builder avoiding the need to create one manually via AndroidPushNotificationTemplate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to baidu(AndroidPushNotificationTemplate).

Parameters:

baidu - a consumer that will call methods on AndroidPushNotificationTemplate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• baidu(AndroidPushNotificationTemplate)

defaultValue

PushNotificationTemplateRequest.Builder defaultValue(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.

defaultValue

default PushNotificationTemplateRequest.Builder defaultValue(Consumer<DefaultPushNotificationTemplate.Builder> defaultValue)

The default message template to use for push notification channels.

This is a convenience method that creates an instance of the DefaultPushNotificationTemplate.Builder avoiding the need to create one manually via DefaultPushNotificationTemplate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultValue(DefaultPushNotificationTemplate).

Parameters:

defaultValue - a consumer that will call methods on DefaultPushNotificationTemplate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• defaultValue(DefaultPushNotificationTemplate)

defaultSubstitutions

PushNotificationTemplateRequest.Builder defaultSubstitutions(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.

gcm

PushNotificationTemplateRequest.Builder gcm(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.

gcm

default PushNotificationTemplateRequest.Builder gcm(Consumer<AndroidPushNotificationTemplate.Builder> 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).

This is a convenience method that creates an instance of the AndroidPushNotificationTemplate.Builder avoiding the need to create one manually via AndroidPushNotificationTemplate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to gcm(AndroidPushNotificationTemplate).

Parameters:

gcm - a consumer that will call methods on AndroidPushNotificationTemplate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• gcm(AndroidPushNotificationTemplate)

recommenderId

PushNotificationTemplateRequest.Builder recommenderId(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.

tags

PushNotificationTemplateRequest.Builder tags(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.

templateDescription

PushNotificationTemplateRequest.Builder templateDescription(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.