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

Interface PushNotificationTemplateResponse.Builder

All Superinterfaces:

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

Enclosing class:

PushNotificationTemplateResponse

public static interface PushNotificationTemplateResponse.Builder
extends SdkPojo, CopyableBuilder<PushNotificationTemplateResponse.Builder,PushNotificationTemplateResponse>

Method Summary

Modifier and Type	Method	Description
default PushNotificationTemplateResponse.Builder	adm(Consumer<AndroidPushNotificationTemplate.Builder> adm)	The message template that's used for the ADM (Amazon Device Messaging) channel.
PushNotificationTemplateResponse.Builder	adm(AndroidPushNotificationTemplate adm)	The message template that's used for the ADM (Amazon Device Messaging) channel.
default PushNotificationTemplateResponse.Builder	apns(Consumer<APNSPushNotificationTemplate.Builder> apns)	The message template that's used for the APNs (Apple Push Notification service) channel.
PushNotificationTemplateResponse.Builder	apns(APNSPushNotificationTemplate apns)	The message template that's used for the APNs (Apple Push Notification service) channel.
PushNotificationTemplateResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the message template.
default PushNotificationTemplateResponse.Builder	baidu(Consumer<AndroidPushNotificationTemplate.Builder> baidu)	The message template that's used for the Baidu (Baidu Cloud Push) channel.
PushNotificationTemplateResponse.Builder	baidu(AndroidPushNotificationTemplate baidu)	The message template that's used for the Baidu (Baidu Cloud Push) channel.
PushNotificationTemplateResponse.Builder	creationDate(String creationDate)	The date, in ISO 8601 format, when the message template was created.
PushNotificationTemplateResponse.Builder	defaultSubstitutions(String defaultSubstitutions)	The JSON object that specifies the default values that are used for message variables in the message template.
default PushNotificationTemplateResponse.Builder	defaultValue(Consumer<DefaultPushNotificationTemplate.Builder> defaultValue)	The default message template that's used for push notification channels.
PushNotificationTemplateResponse.Builder	defaultValue(DefaultPushNotificationTemplate defaultValue)	The default message template that's used for push notification channels.
default PushNotificationTemplateResponse.Builder	gcm(Consumer<AndroidPushNotificationTemplate.Builder> 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.
PushNotificationTemplateResponse.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.
PushNotificationTemplateResponse.Builder	lastModifiedDate(String lastModifiedDate)	The date, in ISO 8601 format, when the message template was last modified.
PushNotificationTemplateResponse.Builder	recommenderId(String recommenderId)	The unique identifier for the recommender model that's used by the message template.
PushNotificationTemplateResponse.Builder	tags(Map<String,String> tags)	A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.
PushNotificationTemplateResponse.Builder	templateDescription(String templateDescription)	The custom description of the message template.
PushNotificationTemplateResponse.Builder	templateName(String templateName)	The name of the message template.
PushNotificationTemplateResponse.Builder	templateType(String templateType)	The type of channel that the message template is designed for.
PushNotificationTemplateResponse.Builder	templateType(TemplateType templateType)	The type of channel that the message template is designed for.
PushNotificationTemplateResponse.Builder	version(String 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.

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, sdkFields

Method Details

adm

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

Parameters:

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

Returns:

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

adm

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

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

Parameters:

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

Returns:

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

apns

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

arn

PushNotificationTemplateResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) of the message template.

Parameters:

arn - The Amazon Resource Name (ARN) of the message template.

Returns:

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

baidu

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

Parameters:

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

Returns:

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

baidu

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

creationDate

PushNotificationTemplateResponse.Builder creationDate(String creationDate)

The date, in ISO 8601 format, when the message template was created.

Parameters:

creationDate - The date, in ISO 8601 format, when the message template was created.

Returns:

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

defaultValue

PushNotificationTemplateResponse.Builder defaultValue(DefaultPushNotificationTemplate defaultValue)

The default message template that's used for push notification channels.

Parameters:

defaultValue - The default message template that's used for push notification channels.

Returns:

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

defaultValue

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

The default message template that's used 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

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

Parameters:

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.

Returns:

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

gcm

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

Parameters:

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

Returns:

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

gcm

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

lastModifiedDate

PushNotificationTemplateResponse.Builder lastModifiedDate(String lastModifiedDate)

The date, in ISO 8601 format, when the message template was last modified.

Parameters:

lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.

Returns:

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

recommenderId

PushNotificationTemplateResponse.Builder recommenderId(String recommenderId)

The unique identifier for the recommender model that's used by the message template.

Parameters:

recommenderId - The unique identifier for the recommender model that's used by the message template.

Returns:

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

tags

PushNotificationTemplateResponse.Builder tags(Map<String,String> 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.

Parameters:

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.

Returns:

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

templateDescription

PushNotificationTemplateResponse.Builder templateDescription(String templateDescription)

The custom description of the message template.

Parameters:

templateDescription - The custom description of the message template.

Returns:

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

templateName

PushNotificationTemplateResponse.Builder templateName(String templateName)

The name of the message template.

Parameters:

templateName - The name of the message template.

Returns:

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

templateType

PushNotificationTemplateResponse.Builder templateType(String templateType)

The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

Parameters:

templateType - The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

Returns:

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

See Also:

• TemplateType
• TemplateType

templateType

PushNotificationTemplateResponse.Builder templateType(TemplateType templateType)

The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

Parameters:

templateType - The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

Returns:

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

See Also:

• TemplateType
• TemplateType

version

PushNotificationTemplateResponse.Builder version(String 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.

Parameters:

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.

Returns:

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