com.amazonaws.services.pinpoint.model

Class MessageRequest

java.lang.Object

com.amazonaws.services.pinpoint.model.MessageRequest

All Implemented Interfaces:

java.io.Serializable

public class MessageRequest
extends java.lang.Object
implements java.io.Serializable

Send message request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageRequest()

Method Summary

Modifier and Type	Method and Description
MessageRequest	addAddressesEntry(java.lang.String key, AddressConfiguration value) A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
MessageRequest	addContextEntry(java.lang.String key, java.lang.String value) A map of custom attributes to attributes to be attached to the message.
MessageRequest	addEndpointsEntry(java.lang.String key, EndpointSendConfiguration value) A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
MessageRequest	clearAddressesEntries() Removes all the entries added into Addresses.
MessageRequest	clearContextEntries() Removes all the entries added into Context.
MessageRequest	clearEndpointsEntries() Removes all the entries added into Endpoints.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,AddressConfiguration>	getAddresses() A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
java.util.Map<java.lang.String,java.lang.String>	getContext() A map of custom attributes to attributes to be attached to the message.
java.util.Map<java.lang.String,EndpointSendConfiguration>	getEndpoints() A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
DirectMessageConfiguration	getMessageConfiguration() Message configuration.
java.lang.String	getTraceId() A unique ID that you can use to trace a message.
int	hashCode()
void	setAddresses(java.util.Map<java.lang.String,AddressConfiguration> addresses) A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
void	setContext(java.util.Map<java.lang.String,java.lang.String> context) A map of custom attributes to attributes to be attached to the message.
void	setEndpoints(java.util.Map<java.lang.String,EndpointSendConfiguration> endpoints) A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
void	setMessageConfiguration(DirectMessageConfiguration messageConfiguration) Message configuration.
void	setTraceId(java.lang.String traceId) A unique ID that you can use to trace a message.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
MessageRequest	withAddresses(java.util.Map<java.lang.String,AddressConfiguration> addresses) A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
MessageRequest	withContext(java.util.Map<java.lang.String,java.lang.String> context) A map of custom attributes to attributes to be attached to the message.
MessageRequest	withEndpoints(java.util.Map<java.lang.String,EndpointSendConfiguration> endpoints) A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
MessageRequest	withMessageConfiguration(DirectMessageConfiguration messageConfiguration) Message configuration.
MessageRequest	withTraceId(java.lang.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

Constructor Detail

MessageRequest

public MessageRequest()

Method Detail

getAddresses

public java.util.Map<java.lang.String,AddressConfiguration> getAddresses()

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.

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.

setAddresses

public void setAddresses(java.util.Map<java.lang.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.

Parameters:

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.

withAddresses

public MessageRequest withAddresses(java.util.Map<java.lang.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.

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

addAddressesEntry

public MessageRequest addAddressesEntry(java.lang.String key,
                                        AddressConfiguration value)

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.

The method adds a new key-value pair into Addresses parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Addresses.

value - The corresponding value of the entry to be added into Addresses.

Returns:

A reference to this updated object so that method calls can be chained together.

clearAddressesEntries

public MessageRequest clearAddressesEntries()

Removes all the entries added into Addresses.

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

getContext

public java.util.Map<java.lang.String,java.lang.String> getContext()

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:

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.

setContext

public void setContext(java.util.Map<java.lang.String,java.lang.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.

withContext

public MessageRequest withContext(java.util.Map<java.lang.String,java.lang.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.

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

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:

A reference to this updated object so that method calls can be chained together.

addContextEntry

public MessageRequest addContextEntry(java.lang.String key,
                                      java.lang.String value)

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.

The method adds a new key-value pair into Context parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Context.

value - The corresponding value of the entry to be added into Context.

Returns:

A reference to this updated object so that method calls can be chained together.

clearContextEntries

public MessageRequest clearContextEntries()

Removes all the entries added into Context.

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

getEndpoints

public java.util.Map<java.lang.String,EndpointSendConfiguration> getEndpoints()

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.

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.

setEndpoints

public void setEndpoints(java.util.Map<java.lang.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.

Parameters:

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.

withEndpoints

public MessageRequest withEndpoints(java.util.Map<java.lang.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.

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

addEndpointsEntry

public MessageRequest addEndpointsEntry(java.lang.String key,
                                        EndpointSendConfiguration value)

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.

The method adds a new key-value pair into Endpoints parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Endpoints.

value - The corresponding value of the entry to be added into Endpoints.

Returns:

A reference to this updated object so that method calls can be chained together.

clearEndpointsEntries

public MessageRequest clearEndpointsEntries()

Removes all the entries added into Endpoints.

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

getMessageConfiguration

public DirectMessageConfiguration getMessageConfiguration()

Message configuration.

Returns:

Message configuration.

setMessageConfiguration

public void setMessageConfiguration(DirectMessageConfiguration messageConfiguration)

Message configuration.

Parameters:

messageConfiguration - Message configuration.

withMessageConfiguration

public MessageRequest withMessageConfiguration(DirectMessageConfiguration messageConfiguration)

Message configuration.

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

Parameters:

messageConfiguration - Message configuration.

Returns:

A reference to this updated object so that method calls can be chained together.

getTraceId

public java.lang.String getTraceId()

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.

setTraceId

public void setTraceId(java.lang.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.

withTraceId

public MessageRequest withTraceId(java.lang.String traceId)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object