MessageRequest (AWS SDK for Java

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

Send message request.

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 attributes to be attached 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()` Message configuration.
`String`	`getTraceId()` A unique ID that you can use to trace a message.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `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 attributes to be attached 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)` Message configuration.
`void`	`setTraceId(String traceId)` A unique ID that you can use to trace a message.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`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 attributes to be attached 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)` Message configuration.
`MessageRequest`	`withTraceId(String traceId)` A unique ID that you can use to trace a message.

Methods inherited from class java.lang.Object
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.
    
    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.
  - 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.
    
    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.
  - 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.
    
    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.
    
    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 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.
    
    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 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. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
    
    Returns:
    
    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
  - 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. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
    
    Parameters:
    
    endpoints - A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
  - 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. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
    
    Parameters:
    
    endpoints - A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
    
    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)
```
    Message configuration.
    
    Parameters:
    
    messageConfiguration - Message configuration.
  - getMessageConfiguration
```
public DirectMessageConfiguration getMessageConfiguration()
```
    Message configuration.
    
    Returns:
    
    Message configuration.
  - withMessageConfiguration
```
public MessageRequest withMessageConfiguration(DirectMessageConfiguration messageConfiguration)
```
    Message configuration.
    
    Parameters:
    
    messageConfiguration - Message configuration.
    
    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 MessageRequest 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.
  - 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 MessageRequest 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 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

setTraceId

getTraceId

withTraceId

toString

equals

hashCode

clone

marshall