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

Send message request.

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)`
`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 attributes to attributes to be attached to the message.
`DirectMessageConfiguration`	`getMessageConfiguration()` Message configuration.
`Map<String,EndpointSendConfiguration>`	`getUsers()` A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContext(Map<String,String> context)` A map of custom attributes to attributes to be attached to the message.
`void`	`setMessageConfiguration(DirectMessageConfiguration messageConfiguration)` Message configuration.
`void`	`setUsers(Map<String,EndpointSendConfiguration> users)` A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SendUsersMessageRequest`	`withContext(Map<String,String> context)` A map of custom attributes to attributes to be attached to the message.
`SendUsersMessageRequest`	`withMessageConfiguration(DirectMessageConfiguration messageConfiguration)` Message configuration.
`SendUsersMessageRequest`	`withUsers(Map<String,EndpointSendConfiguration> users)` A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.

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 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(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.
    
    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 SendUsersMessageRequest withContext(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.
    
    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:
    
    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 configuration.
    
    Parameters:
    
    messageConfiguration - Message configuration.
  - getMessageConfiguration
```
public DirectMessageConfiguration getMessageConfiguration()
```
    Message configuration.
    
    Returns:
    
    Message configuration.
  - withMessageConfiguration
```
public SendUsersMessageRequest withMessageConfiguration(DirectMessageConfiguration messageConfiguration)
```
    Message configuration.
    
    Parameters:
    
    messageConfiguration - Message configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUsers
```
public Map<String,EndpointSendConfiguration> getUsers()
```
    A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
    
    Returns:
    
    A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
  - setUsers
```
public void setUsers(Map<String,EndpointSendConfiguration> users)
```
    A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
    
    Parameters:
    
    users - A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
  - withUsers
```
public SendUsersMessageRequest withUsers(Map<String,EndpointSendConfiguration> users)
```
    A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
    
    Parameters:
    
    users - A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
    
    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)
```
    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.

Did this page help you?

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

getUsers

setUsers

withUsers

addUsersEntry

clearUsersEntries

toString

equals

hashCode

clone

marshall