com.amazonaws.services.pinpoint.model

Class SendUsersMessageRequest

java.lang.Object

com.amazonaws.services.pinpoint.model.SendUsersMessageRequest

All Implemented Interfaces:

java.io.Serializable

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

Send message request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendUsersMessageRequest()

Method Summary

Modifier and Type	Method and Description
SendUsersMessageRequest	addContextEntry(java.lang.String key, java.lang.String value) A map of custom attribute-value pairs.
SendUsersMessageRequest	addUsersEntry(java.lang.String key, EndpointSendConfiguration value) A map that associates user IDs with EndpointSendConfiguration objects.
SendUsersMessageRequest	clearContextEntries() Removes all the entries added into Context.
SendUsersMessageRequest	clearUsersEntries() Removes all the entries added into Users.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getContext() A map of custom attribute-value pairs.
DirectMessageConfiguration	getMessageConfiguration() Message definitions for the default message and any messages that are tailored for specific channels.
java.lang.String	getTraceId() A unique ID that you can use to trace a message.
java.util.Map<java.lang.String,EndpointSendConfiguration>	getUsers() A map that associates user IDs with EndpointSendConfiguration objects.
int	hashCode()
void	setContext(java.util.Map<java.lang.String,java.lang.String> context) A map of custom attribute-value pairs.
void	setMessageConfiguration(DirectMessageConfiguration messageConfiguration) Message definitions for the default message and any messages that are tailored for specific channels.
void	setTraceId(java.lang.String traceId) A unique ID that you can use to trace a message.
void	setUsers(java.util.Map<java.lang.String,EndpointSendConfiguration> users) A map that associates user IDs with EndpointSendConfiguration objects.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SendUsersMessageRequest	withContext(java.util.Map<java.lang.String,java.lang.String> context) A map of custom attribute-value pairs.
SendUsersMessageRequest	withMessageConfiguration(DirectMessageConfiguration messageConfiguration) Message definitions for the default message and any messages that are tailored for specific channels.
SendUsersMessageRequest	withTraceId(java.lang.String traceId) A unique ID that you can use to trace a message.
SendUsersMessageRequest	withUsers(java.util.Map<java.lang.String,EndpointSendConfiguration> users) A map that associates user IDs with EndpointSendConfiguration objects.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendUsersMessageRequest

public SendUsersMessageRequest()

Method Detail

getContext

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

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:

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.

setContext

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

withContext

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

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

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:

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

addContextEntry

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

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.

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 SendUsersMessageRequest clearContextEntries()

Removes all the entries added into Context.

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

getMessageConfiguration

public DirectMessageConfiguration getMessageConfiguration()

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

Returns:

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

setMessageConfiguration

public void setMessageConfiguration(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.

withMessageConfiguration

public SendUsersMessageRequest withMessageConfiguration(DirectMessageConfiguration messageConfiguration)

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

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

Parameters:

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

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

getUsers

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

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:

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.

setUsers

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

withUsers

public SendUsersMessageRequest withUsers(java.util.Map<java.lang.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.

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

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:

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

addUsersEntry

public SendUsersMessageRequest addUsersEntry(java.lang.String key,
                                             EndpointSendConfiguration value)

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.

The method adds a new key-value pair into Users 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 Users.

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

Returns:

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

clearUsersEntries

public SendUsersMessageRequest clearUsersEntries()

Removes all the entries added into Users.

Returns a reference to this 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