Interface SendUsersMessageRequest.Builder

All Superinterfaces:

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

Enclosing class:

SendUsersMessageRequest

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

Method Summary

Modifier and Type	Method	Description
SendUsersMessageRequest.Builder	context(Map<String,String> context)	A map of custom attribute-value pairs.
default SendUsersMessageRequest.Builder	messageConfiguration(Consumer<DirectMessageConfiguration.Builder> messageConfiguration)	The settings and content for the default message and any default messages that you defined for specific channels.
SendUsersMessageRequest.Builder	messageConfiguration(DirectMessageConfiguration messageConfiguration)	The settings and content for the default message and any default messages that you defined for specific channels.
default SendUsersMessageRequest.Builder	templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)	The message template to use for the message.
SendUsersMessageRequest.Builder	templateConfiguration(TemplateConfiguration templateConfiguration)	The message template to use for the message.
SendUsersMessageRequest.Builder	traceId(String traceId)	The unique identifier for tracing the message.
SendUsersMessageRequest.Builder	users(Map<String,EndpointSendConfiguration> users)	A map that associates user IDs with EndpointSendConfiguration objects.

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

context

SendUsersMessageRequest.Builder context(Map<String,String> context)

A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

Parameters:

context - A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

Returns:

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

messageConfiguration

SendUsersMessageRequest.Builder messageConfiguration(DirectMessageConfiguration messageConfiguration)

The settings and content for the default message and any default messages that you defined for specific channels.

Parameters:

messageConfiguration - The settings and content for the default message and any default messages that you defined for specific channels.

Returns:

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

messageConfiguration

default SendUsersMessageRequest.Builder messageConfiguration(Consumer<DirectMessageConfiguration.Builder> messageConfiguration)

The settings and content for the default message and any default messages that you defined for specific channels.

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

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

Parameters:

messageConfiguration - a consumer that will call methods on DirectMessageConfiguration.Builder

Returns:

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

See Also:

• messageConfiguration(DirectMessageConfiguration)

templateConfiguration

SendUsersMessageRequest.Builder templateConfiguration(TemplateConfiguration templateConfiguration)

The message template to use for the message.

Parameters:

templateConfiguration - The message template to use for the message.

Returns:

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

templateConfiguration

default SendUsersMessageRequest.Builder templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)

The message template to use for the message.

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

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

Parameters:

templateConfiguration - a consumer that will call methods on TemplateConfiguration.Builder

Returns:

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

See Also:

• templateConfiguration(TemplateConfiguration)

traceId

SendUsersMessageRequest.Builder traceId(String traceId)

The unique identifier for tracing the message. This identifier is visible to message recipients.

Parameters:

traceId - The unique identifier for tracing the message. This identifier is visible to message recipients.

Returns:

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

users

SendUsersMessageRequest.Builder users(Map<String,EndpointSendConfiguration> users)

A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

Parameters:

users - A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

Returns:

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