software.amazon.awssdk.services.pinpoint.model

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 and Description
SendUsersMessageRequest.Builder	context(Map<String,String> context) A map of custom attribute-value pairs.
default SendUsersMessageRequest.Builder	messageConfiguration(Consumer<DirectMessageConfiguration.Builder> messageConfiguration) Message definitions for the default message and any messages that are tailored for specific channels.
SendUsersMessageRequest.Builder	messageConfiguration(DirectMessageConfiguration messageConfiguration) Message definitions for the default message and any messages that are tailored for specific channels.
SendUsersMessageRequest.Builder	traceId(String traceId) A unique ID that you can use to trace a message.
SendUsersMessageRequest.Builder	users(Map<String,EndpointSendConfiguration> users) A map that associates user IDs with EndpointSendConfiguration objects.

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

sdkFields

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

copy

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

applyMutation, build

Method Detail

context

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

A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push 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. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push 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)

Message definitions for the default message and any messages that are tailored for specific channels.

Parameters:

messageConfiguration - Message definitions for the default message and any messages that are tailored 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)

Message definitions for the default message and any messages that are tailored for specific channels. This is a convenience 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)

traceId

SendUsersMessageRequest.Builder traceId(String traceId)

A unique ID that you can use to trace a message. This ID is visible to recipients.

Parameters:

traceId - A unique ID that you can use to trace a message. This ID is visible to 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. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.

Parameters:

users - A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.

Returns:

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