MessageRequest (AWS SDK for Android - Amazon Pinpoint 2.6.21 API)

java.lang.Object
- com.amazonaws.services.pinpoint.model.MessageRequest

All Implemented Interfaces:

Serializable
```
public class MessageRequest
extends Object
implements Serializable
```
Send message request.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MessageRequest()

Constructors
Constructor and Description
`MessageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessageRequest`	`addAddressesEntry(String key, AddressConfiguration value)` A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
`MessageRequest`	`addContextEntry(String key, String value)` A map of custom attributes to attributes to be attached to the message.
`MessageRequest`	`addEndpointsEntry(String key, EndpointSendConfiguration value)` A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
`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(Object obj)`
`Map<String,AddressConfiguration>`	`getAddresses()` A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
`Map<String,String>`	`getContext()` A map of custom attributes to attributes to be attached to the message.
`Map<String,EndpointSendConfiguration>`	`getEndpoints()` A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
`DirectMessageConfiguration`	`getMessageConfiguration()` Message configuration.
`int`	`hashCode()`
`void`	`setAddresses(Map<String,AddressConfiguration> addresses)` A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
`void`	`setContext(Map<String,String> context)` A map of custom attributes to attributes to be attached to the message.
`void`	`setEndpoints(Map<String,EndpointSendConfiguration> endpoints)` A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
`void`	`setMessageConfiguration(DirectMessageConfiguration messageConfiguration)` Message configuration.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`MessageRequest`	`withAddresses(Map<String,AddressConfiguration> addresses)` A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
`MessageRequest`	`withContext(Map<String,String> context)` A map of custom attributes to attributes to be attached to the message.
`MessageRequest`	`withEndpoints(Map<String,EndpointSendConfiguration> endpoints)` A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
`MessageRequest`	`withMessageConfiguration(DirectMessageConfiguration messageConfiguration)` Message configuration.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MessageRequest
```
public MessageRequest()
```
- Method Detail
  - getAddresses
```
public Map<String,AddressConfiguration> getAddresses()
```
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    
    Returns:
    
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
  - setAddresses
```
public void setAddresses(Map<String,AddressConfiguration> addresses)
```
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    
    Parameters:
    
    addresses - A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
  - withAddresses
```
public MessageRequest withAddresses(Map<String,AddressConfiguration> addresses)
```
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    addresses - A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAddressesEntry
```
public MessageRequest addAddressesEntry(String key,
                                        AddressConfiguration value)
```
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    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 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 MessageRequest 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.
    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(String key,
                                      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 Map<String,EndpointSendConfiguration> getEndpoints()
```
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    
    Returns:
    
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
  - setEndpoints
```
public void setEndpoints(Map<String,EndpointSendConfiguration> endpoints)
```
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    
    Parameters:
    
    endpoints - A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
  - withEndpoints
```
public MessageRequest withEndpoints(Map<String,EndpointSendConfiguration> endpoints)
```
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endpoints - A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addEndpointsEntry
```
public MessageRequest addEndpointsEntry(String key,
                                        EndpointSendConfiguration value)
```
    A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
    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.
  - 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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class MessageRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageRequest

Method Detail

getAddresses

setAddresses

withAddresses

addAddressesEntry

clearAddressesEntries

getContext

setContext

withContext

addContextEntry

clearContextEntries

getEndpoints

setEndpoints

withEndpoints

addEndpointsEntry

clearEndpointsEntries

getMessageConfiguration

setMessageConfiguration

withMessageConfiguration

toString

hashCode

equals