software.amazon.awssdk.services.pinpoint.model

Interface AddressConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

AddressConfiguration

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

Method Summary

Modifier and Type	Method and Description
AddressConfiguration.Builder	bodyOverride(String bodyOverride) The message body to use instead of the default message body.
AddressConfiguration.Builder	channelType(ChannelType channelType) The channel to use when sending the message.
AddressConfiguration.Builder	channelType(String channelType) The channel to use when sending the message.
AddressConfiguration.Builder	context(Map<String,String> context) An object that maps custom attributes to attributes for the address and is attached to the message.
AddressConfiguration.Builder	rawContent(String rawContent) The raw, JSON-formatted string to use as the payload for the message.
AddressConfiguration.Builder	substitutions(Map<String,? extends Collection<String>> substitutions) A map of the message variables to merge with the variables specified by properties of the DefaultMessage object.
AddressConfiguration.Builder	titleOverride(String titleOverride) The message title to use instead of the default message title.

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

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

bodyOverride

AddressConfiguration.Builder bodyOverride(String bodyOverride)

The message body to use instead of the default message body. This value overrides the default message body.

Parameters:

bodyOverride - The message body to use instead of the default message body. This value overrides the default message body.

Returns:

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

channelType

AddressConfiguration.Builder channelType(String channelType)

The channel to use when sending the message.

Parameters:

channelType - The channel to use when sending the message.

Returns:

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

See Also:

ChannelType, ChannelType

channelType

AddressConfiguration.Builder channelType(ChannelType channelType)

The channel to use when sending the message.

Parameters:

channelType - The channel to use when sending the message.

Returns:

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

See Also:

ChannelType, ChannelType

context

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

An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

Parameters:

context - An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

Returns:

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

rawContent

AddressConfiguration.Builder rawContent(String rawContent)

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

Parameters:

rawContent - The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

Returns:

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

substitutions

AddressConfiguration.Builder substitutions(Map<String,? extends Collection<String>> substitutions)

A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

Parameters:

substitutions - A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

Returns:

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

titleOverride

AddressConfiguration.Builder titleOverride(String titleOverride)

The message title to use instead of the default message title. This value overrides the default message title.

Parameters:

titleOverride - The message title to use instead of the default message title. This value overrides the default message title.

Returns:

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