software.amazon.awssdk.services.pinpoint.model

Interface MessageRequest.Builder

All Superinterfaces:

CopyableBuilder<MessageRequest.Builder,MessageRequest>, SdkBuilder<MessageRequest.Builder,MessageRequest>

Enclosing class:

MessageRequest

public static interface MessageRequest.Builder
extends CopyableBuilder<MessageRequest.Builder,MessageRequest>

Method Summary

Modifier and Type	Method and Description
MessageRequest.Builder	addresses(Map<String,AddressConfiguration> addresses) A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
MessageRequest.Builder	context(Map<String,String> context) A map of custom attributes to attributes to be attached to the message.
MessageRequest.Builder	endpoints(Map<String,EndpointSendConfiguration> endpoints) A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
default MessageRequest.Builder	messageConfiguration(Consumer<DirectMessageConfiguration.Builder> messageConfiguration) Message configuration.
MessageRequest.Builder	messageConfiguration(DirectMessageConfiguration messageConfiguration) Message configuration.

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

copy

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

apply, build

Method Detail

addresses

MessageRequest.Builder addresses(Map<String,AddressConfiguration> addresses)

A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.

Parameters:

addresses - A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.

Returns:

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

context

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

A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

Parameters:

context - A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

Returns:

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

endpoints

MessageRequest.Builder endpoints(Map<String,EndpointSendConfiguration> endpoints)

A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.

Parameters:

endpoints - A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.

Returns:

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

messageConfiguration

MessageRequest.Builder messageConfiguration(DirectMessageConfiguration messageConfiguration)

Message configuration.

Parameters:

messageConfiguration - Message configuration.

Returns:

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

messageConfiguration

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

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