software.amazon.awssdk.services.pinpoint.model

Class MessageRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.MessageRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MessageRequest.Builder,MessageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class MessageRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MessageRequest.Builder,MessageRequest>

Send message request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,AddressConfiguration>	addresses() A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
static MessageRequest.Builder	builder()
Map<String,String>	context() A map of custom attributes to attributes to be attached to the message.
Map<String,EndpointSendConfiguration>	endpoints() A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DirectMessageConfiguration	messageConfiguration() Message configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends MessageRequest.Builder>	serializableBuilderClass()
MessageRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	traceId() A unique ID that you can use to trace a message.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

addresses

public Map<String,AddressConfiguration> addresses()

A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address.

context

public 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

endpoints

public Map<String,EndpointSendConfiguration> endpoints()

A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.

messageConfiguration

public DirectMessageConfiguration messageConfiguration()

Message configuration.

Returns:

Message configuration.

traceId

public String traceId()

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

Returns:

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

toBuilder

public MessageRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MessageRequest.Builder,MessageRequest>

Returns:

a builder for type T

builder

public static MessageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends MessageRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.