com.amazonaws.services.pinpoint.model

Class SendUsersMessageRequest

java.lang.Object

com.amazonaws.services.pinpoint.model.SendUsersMessageRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendUsersMessageRequest
extends Object
implements Serializable, Cloneable, StructuredPojo

Send message request.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendUsersMessageRequest()

Method Summary

Modifier and Type	Method and Description
SendUsersMessageRequest	addContextEntry(String key, String value)
SendUsersMessageRequest	addUsersEntry(String key, EndpointSendConfiguration value)
SendUsersMessageRequest	clearContextEntries() Removes all the entries added into Context.
SendUsersMessageRequest	clearUsersEntries() Removes all the entries added into Users.
SendUsersMessageRequest	clone()
boolean	equals(Object obj)
Map<String,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.
String	getTraceId() A unique ID that you can use to trace a message.
Map<String,EndpointSendConfiguration>	getUsers() A map that associates user IDs with EndpointSendConfiguration objects.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setContext(Map<String,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(String traceId) A unique ID that you can use to trace a message.
void	setUsers(Map<String,EndpointSendConfiguration> users) A map that associates user IDs with EndpointSendConfiguration objects.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SendUsersMessageRequest	withContext(Map<String,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(String traceId) A unique ID that you can use to trace a message.
SendUsersMessageRequest	withUsers(Map<String,EndpointSendConfiguration> users) A map that associates user IDs with EndpointSendConfiguration objects.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendUsersMessageRequest

public SendUsersMessageRequest()

Method Detail

getContext

public Map<String,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(Map<String,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(Map<String,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.

Returns:

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

addContextEntry

public SendUsersMessageRequest addContextEntry(String key,
                                               String value)

clearContextEntries

public SendUsersMessageRequest clearContextEntries()

Removes all the entries added into Context.

Returns:

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

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.

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.

withMessageConfiguration

public SendUsersMessageRequest withMessageConfiguration(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.

Returns:

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

setTraceId

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

getTraceId

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

withTraceId

public SendUsersMessageRequest withTraceId(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.

Returns:

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

getUsers

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

Returns:

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

addUsersEntry

public SendUsersMessageRequest addUsersEntry(String key,
                                             EndpointSendConfiguration value)

clearUsersEntries

public SendUsersMessageRequest clearUsersEntries()

Removes all the entries added into Users.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SendUsersMessageRequest clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo