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

Interface MessageConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

MessageConfiguration

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

Method Summary

Modifier and Type	Method	Description
default MessageConfiguration.Builder	admMessage(Consumer<Message.Builder> admMessage)	The message that the campaign sends through the ADM (Amazon Device Messaging) channel.
MessageConfiguration.Builder	admMessage(Message admMessage)	The message that the campaign sends through the ADM (Amazon Device Messaging) channel.
default MessageConfiguration.Builder	apnsMessage(Consumer<Message.Builder> apnsMessage)	The message that the campaign sends through the APNs (Apple Push Notification service) channel.
MessageConfiguration.Builder	apnsMessage(Message apnsMessage)	The message that the campaign sends through the APNs (Apple Push Notification service) channel.
default MessageConfiguration.Builder	baiduMessage(Consumer<Message.Builder> baiduMessage)	The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.
MessageConfiguration.Builder	baiduMessage(Message baiduMessage)	The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.
default MessageConfiguration.Builder	customMessage(Consumer<CampaignCustomMessage.Builder> customMessage)	The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign.
MessageConfiguration.Builder	customMessage(CampaignCustomMessage customMessage)	The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign.
default MessageConfiguration.Builder	defaultMessage(Consumer<Message.Builder> defaultMessage)	The default message that the campaign sends through all the channels that are configured for the campaign.
MessageConfiguration.Builder	defaultMessage(Message defaultMessage)	The default message that the campaign sends through all the channels that are configured for the campaign.
default MessageConfiguration.Builder	emailMessage(Consumer<CampaignEmailMessage.Builder> emailMessage)	The message that the campaign sends through the email channel.
MessageConfiguration.Builder	emailMessage(CampaignEmailMessage emailMessage)	The message that the campaign sends through the email channel.
default MessageConfiguration.Builder	gcmMessage(Consumer<Message.Builder> gcmMessage)	The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
MessageConfiguration.Builder	gcmMessage(Message gcmMessage)	The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
default MessageConfiguration.Builder	inAppMessage(Consumer<CampaignInAppMessage.Builder> inAppMessage)	The in-app message configuration.
MessageConfiguration.Builder	inAppMessage(CampaignInAppMessage inAppMessage)	The in-app message configuration.
default MessageConfiguration.Builder	smsMessage(Consumer<CampaignSmsMessage.Builder> smsMessage)	The message that the campaign sends through the SMS channel.
MessageConfiguration.Builder	smsMessage(CampaignSmsMessage smsMessage)	The message that the campaign sends through the SMS channel.

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 Detail

admMessage

MessageConfiguration.Builder admMessage(Message admMessage)

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

Parameters:

admMessage - The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

Returns:

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

admMessage

default MessageConfiguration.Builder admMessage(Consumer<Message.Builder> admMessage)

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

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

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

Parameters:

admMessage - a consumer that will call methods on Message.Builder

Returns:

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

See Also:

admMessage(Message)

apnsMessage

MessageConfiguration.Builder apnsMessage(Message apnsMessage)

The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

Parameters:

apnsMessage - The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

Returns:

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

apnsMessage

default MessageConfiguration.Builder apnsMessage(Consumer<Message.Builder> apnsMessage)

The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

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

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

Parameters:

apnsMessage - a consumer that will call methods on Message.Builder

Returns:

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

See Also:

apnsMessage(Message)

baiduMessage

MessageConfiguration.Builder baiduMessage(Message baiduMessage)

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

Parameters:

baiduMessage - The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

Returns:

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

baiduMessage

default MessageConfiguration.Builder baiduMessage(Consumer<Message.Builder> baiduMessage)

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

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

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

Parameters:

baiduMessage - a consumer that will call methods on Message.Builder

Returns:

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

See Also:

baiduMessage(Message)

customMessage

MessageConfiguration.Builder customMessage(CampaignCustomMessage customMessage)

The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

Parameters:

customMessage - The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

Returns:

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

customMessage

default MessageConfiguration.Builder customMessage(Consumer<CampaignCustomMessage.Builder> customMessage)

The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

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

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

Parameters:

customMessage - a consumer that will call methods on CampaignCustomMessage.Builder

Returns:

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

See Also:

customMessage(CampaignCustomMessage)

defaultMessage

MessageConfiguration.Builder defaultMessage(Message defaultMessage)

The default message that the campaign sends through all the channels that are configured for the campaign.

Parameters:

defaultMessage - The default message that the campaign sends through all the channels that are configured for the campaign.

Returns:

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

defaultMessage

default MessageConfiguration.Builder defaultMessage(Consumer<Message.Builder> defaultMessage)

The default message that the campaign sends through all the channels that are configured for the campaign.

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

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

Parameters:

defaultMessage - a consumer that will call methods on Message.Builder

Returns:

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

See Also:

defaultMessage(Message)

emailMessage

MessageConfiguration.Builder emailMessage(CampaignEmailMessage emailMessage)

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

Parameters:

emailMessage - The message that the campaign sends through the email channel. If specified, this message overrides the default message.

Returns:

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

emailMessage

default MessageConfiguration.Builder emailMessage(Consumer<CampaignEmailMessage.Builder> emailMessage)

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

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

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

Parameters:

emailMessage - a consumer that will call methods on CampaignEmailMessage.Builder

Returns:

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

See Also:

emailMessage(CampaignEmailMessage)

gcmMessage

MessageConfiguration.Builder gcmMessage(Message gcmMessage)

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

Parameters:

gcmMessage - The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

Returns:

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

gcmMessage

default MessageConfiguration.Builder gcmMessage(Consumer<Message.Builder> gcmMessage)

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

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

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

Parameters:

gcmMessage - a consumer that will call methods on Message.Builder

Returns:

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

See Also:

gcmMessage(Message)

smsMessage

MessageConfiguration.Builder smsMessage(CampaignSmsMessage smsMessage)

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

Parameters:

smsMessage - The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

Returns:

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

smsMessage

default MessageConfiguration.Builder smsMessage(Consumer<CampaignSmsMessage.Builder> smsMessage)

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

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

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

Parameters:

smsMessage - a consumer that will call methods on CampaignSmsMessage.Builder

Returns:

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

See Also:

smsMessage(CampaignSmsMessage)

inAppMessage

MessageConfiguration.Builder inAppMessage(CampaignInAppMessage inAppMessage)

The in-app message configuration.

Parameters:

inAppMessage - The in-app message configuration.

Returns:

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

inAppMessage

default MessageConfiguration.Builder inAppMessage(Consumer<CampaignInAppMessage.Builder> inAppMessage)

The in-app message configuration.

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

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

Parameters:

inAppMessage - a consumer that will call methods on CampaignInAppMessage.Builder

Returns:

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

See Also:

inAppMessage(CampaignInAppMessage)