SendUsersMessageRequest (AWS SDK for Java

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
```
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SendUsersMessageRequest()

Constructors
Constructor and Description
`SendUsersMessageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SendUsersMessageRequest`	`addContextEntry(String key, String value)` Add a single Context entry
`SendUsersMessageRequest`	`addUsersEntry(String key, EndpointSendConfiguration value)` Add a single Users entry
`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()` The settings and content for the default message and any default messages that you defined for specific channels.
`TemplateConfiguration`	`getTemplateConfiguration()` The message template to use for the message.
`String`	`getTraceId()` The unique identifier for tracing the message.
`Map<String,EndpointSendConfiguration>`	`getUsers()` A map that associates user IDs with EndpointSendConfiguration objects.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContext(Map<String,String> context)` A map of custom attribute-value pairs.
`void`	`setMessageConfiguration(DirectMessageConfiguration messageConfiguration)` The settings and content for the default message and any default messages that you defined for specific channels.
`void`	`setTemplateConfiguration(TemplateConfiguration templateConfiguration)` The message template to use for the message.
`void`	`setTraceId(String traceId)` The unique identifier for tracing the 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.
`SendUsersMessageRequest`	`withContext(Map<String,String> context)` A map of custom attribute-value pairs.
`SendUsersMessageRequest`	`withMessageConfiguration(DirectMessageConfiguration messageConfiguration)` The settings and content for the default message and any default messages that you defined for specific channels.
`SendUsersMessageRequest`	`withTemplateConfiguration(TemplateConfiguration templateConfiguration)` The message template to use for the message.
`SendUsersMessageRequest`	`withTraceId(String traceId)` The unique identifier for tracing the message.
`SendUsersMessageRequest`	`withUsers(Map<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 Map<String,String> getContext()
```
    A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the 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. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the 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. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the 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. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the 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. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the 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. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the 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)
```
    Add a single Context entry
    
    See Also:
    
    withContext(java.util.Map<java.lang.String, java.lang.String>)
  - 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)
```
    The settings and content for the default message and any default messages that you defined for specific channels.
    
    Parameters:
    
    messageConfiguration - The settings and content for the default message and any default messages that you defined for specific channels.
  - getMessageConfiguration
```
public DirectMessageConfiguration getMessageConfiguration()
```
    The settings and content for the default message and any default messages that you defined for specific channels.
    
    Returns:
    
    The settings and content for the default message and any default messages that you defined for specific channels.
  - withMessageConfiguration
```
public SendUsersMessageRequest withMessageConfiguration(DirectMessageConfiguration messageConfiguration)
```
    The settings and content for the default message and any default messages that you defined for specific channels.
    
    Parameters:
    
    messageConfiguration - The settings and content for the default message and any default messages that you defined for specific channels.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateConfiguration
```
public void setTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    The message template to use for the message.
    
    Parameters:
    
    templateConfiguration - The message template to use for the message.
  - getTemplateConfiguration
```
public TemplateConfiguration getTemplateConfiguration()
```
    The message template to use for the message.
    
    Returns:
    
    The message template to use for the message.
  - withTemplateConfiguration
```
public SendUsersMessageRequest withTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    The message template to use for the message.
    
    Parameters:
    
    templateConfiguration - The message template to use for the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTraceId
```
public void setTraceId(String traceId)
```
    The unique identifier for tracing the message. This identifier is visible to message recipients.
    
    Parameters:
    
    traceId - The unique identifier for tracing the message. This identifier is visible to message recipients.
  - getTraceId
```
public String getTraceId()
```
    The unique identifier for tracing the message. This identifier is visible to message recipients.
    
    Returns:
    
    The unique identifier for tracing the message. This identifier is visible to message recipients.
  - withTraceId
```
public SendUsersMessageRequest withTraceId(String traceId)
```
    The unique identifier for tracing the message. This identifier is visible to message recipients.
    
    Parameters:
    
    traceId - The unique identifier for tracing the message. This identifier is visible to message 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. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
    
    Returns:
    
    A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
  - setUsers
```
public void setUsers(Map<String,EndpointSendConfiguration> users)
```
    A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
    
    Parameters:
    
    users - A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
  - withUsers
```
public SendUsersMessageRequest withUsers(Map<String,EndpointSendConfiguration> users)
```
    A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
    
    Parameters:
    
    users - A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addUsersEntry
```
public SendUsersMessageRequest addUsersEntry(String key,
                                             EndpointSendConfiguration value)
```
    Add a single Users entry
    
    See Also:
    
    withUsers(java.util.Map<java.lang.String, com.amazonaws.services.pinpoint.model.EndpointSendConfiguration>)
  - 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class SendUsersMessageRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SendUsersMessageRequest

Method Detail

getContext

setContext

withContext

addContextEntry

clearContextEntries

setMessageConfiguration

getMessageConfiguration

withMessageConfiguration

setTemplateConfiguration

getTemplateConfiguration

withTemplateConfiguration

setTraceId

getTraceId

withTraceId

getUsers

setUsers

withUsers

addUsersEntry

clearUsersEntries

toString

equals

hashCode

clone

marshall