MessageRequest (AWS Java SDK for Amazon Pinpoint 1.11.679 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MessageRequest
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the configuration and other settings for a message.

See Also:

AWS API Documentation, 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)`
`MessageRequest`	`addContextEntry(String key, String value)`
`MessageRequest`	`addEndpointsEntry(String key, EndpointSendConfiguration 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.
`MessageRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,AddressConfiguration>`	`getAddresses()` A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
`Map<String,String>`	`getContext()` A map of custom attributes to attach to the message.
`Map<String,EndpointSendConfiguration>`	`getEndpoints()` A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
`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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAddresses(Map<String,AddressConfiguration> addresses)` A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
`void`	`setContext(Map<String,String> context)` A map of custom attributes to attach to the message.
`void`	`setEndpoints(Map<String,EndpointSendConfiguration> endpoints)` A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
`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.
`String`	`toString()` Returns a string representation of this object.
`MessageRequest`	`withAddresses(Map<String,AddressConfiguration> addresses)` A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object.
`MessageRequest`	`withContext(Map<String,String> context)` A map of custom attributes to attach to the message.
`MessageRequest`	`withEndpoints(Map<String,EndpointSendConfiguration> endpoints)` A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object.
`MessageRequest`	`withMessageConfiguration(DirectMessageConfiguration messageConfiguration)` The settings and content for the default message and any default messages that you defined for specific channels.
`MessageRequest`	`withTemplateConfiguration(TemplateConfiguration templateConfiguration)` The message template to use for the message.
`MessageRequest`	`withTraceId(String traceId)` The unique identifier for tracing the message.

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

- Constructor Detail
  - MessageRequest
```
public MessageRequest()
```
- Method Detail
  - getAddresses
```
public Map<String,AddressConfiguration> getAddresses()
```
    A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
    
    Returns:
    
    A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
  - setAddresses
```
public void setAddresses(Map<String,AddressConfiguration> addresses)
```
    A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
    
    Parameters:
    
    addresses - A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
  - withAddresses
```
public MessageRequest withAddresses(Map<String,AddressConfiguration> addresses)
```
    A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
    
    Parameters:
    
    addresses - A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address 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.
  - addAddressesEntry
```
public MessageRequest addAddressesEntry(String key,
                                        AddressConfiguration value)
```
  - clearAddressesEntries
```
public MessageRequest clearAddressesEntries()
```
    Removes all the entries added into Addresses.
    
    Returns:
    
    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 attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
    
    Returns:
    
    A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
  - setContext
```
public void setContext(Map<String,String> context)
```
    A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
    
    Parameters:
    
    context - A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
  - withContext
```
public MessageRequest withContext(Map<String,String> context)
```
    A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
    
    Parameters:
    
    context - A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addContextEntry
```
public MessageRequest addContextEntry(String key,
                                      String value)
```
  - clearContextEntries
```
public MessageRequest clearContextEntries()
```
    Removes all the entries added into Context.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEndpoints
```
public Map<String,EndpointSendConfiguration> getEndpoints()
```
    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
    
    Returns:
    
    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
  - setEndpoints
```
public void setEndpoints(Map<String,EndpointSendConfiguration> endpoints)
```
    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
    
    Parameters:
    
    endpoints - A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
  - withEndpoints
```
public MessageRequest withEndpoints(Map<String,EndpointSendConfiguration> endpoints)
```
    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
    
    Parameters:
    
    endpoints - A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint 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.
  - addEndpointsEntry
```
public MessageRequest addEndpointsEntry(String key,
                                        EndpointSendConfiguration value)
```
  - clearEndpointsEntries
```
public MessageRequest clearEndpointsEntries()
```
    Removes all the entries added into Endpoints.
    
    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 MessageRequest 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 MessageRequest 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 MessageRequest 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.
  - 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 MessageRequest clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

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

setMessageConfiguration

getMessageConfiguration

withMessageConfiguration

setTemplateConfiguration

getTemplateConfiguration

withTemplateConfiguration

setTraceId

getTraceId

withTraceId

toString

equals

hashCode

clone

marshall