@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class EndpointSendConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
Constructor and Description |
---|
EndpointSendConfiguration() |
Modifier and Type | Method and Description |
---|---|
EndpointSendConfiguration |
addContextEntry(String key,
String value)
Add a single Context entry
|
EndpointSendConfiguration |
addSubstitutionsEntry(String key,
List<String> value)
Add a single Substitutions entry
|
EndpointSendConfiguration |
clearContextEntries()
Removes all the entries added into Context.
|
EndpointSendConfiguration |
clearSubstitutionsEntries()
Removes all the entries added into Substitutions.
|
EndpointSendConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getBodyOverride()
The body of the message.
|
Map<String,String> |
getContext()
A map of custom attributes to attach to the message for the address.
|
String |
getRawContent()
The raw, JSON-formatted string to use as the payload for the message.
|
Map<String,List<String>> |
getSubstitutions()
A map of the message variables to merge with the variables specified for the default message
(DefaultMessage.Substitutions).
|
String |
getTitleOverride()
The title or subject line of the message.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBodyOverride(String bodyOverride)
The body of the message.
|
void |
setContext(Map<String,String> context)
A map of custom attributes to attach to the message for the address.
|
void |
setRawContent(String rawContent)
The raw, JSON-formatted string to use as the payload for the message.
|
void |
setSubstitutions(Map<String,List<String>> substitutions)
A map of the message variables to merge with the variables specified for the default message
(DefaultMessage.Substitutions).
|
void |
setTitleOverride(String titleOverride)
The title or subject line of the message.
|
String |
toString()
Returns a string representation of this object.
|
EndpointSendConfiguration |
withBodyOverride(String bodyOverride)
The body of the message.
|
EndpointSendConfiguration |
withContext(Map<String,String> context)
A map of custom attributes to attach to the message for the address.
|
EndpointSendConfiguration |
withRawContent(String rawContent)
The raw, JSON-formatted string to use as the payload for the message.
|
EndpointSendConfiguration |
withSubstitutions(Map<String,List<String>> substitutions)
A map of the message variables to merge with the variables specified for the default message
(DefaultMessage.Substitutions).
|
EndpointSendConfiguration |
withTitleOverride(String titleOverride)
The title or subject line of the message.
|
public void setBodyOverride(String bodyOverride)
The body of the message. If specified, this value overrides the default message body.
bodyOverride
- The body of the message. If specified, this value overrides the default message body.public String getBodyOverride()
The body of the message. If specified, this value overrides the default message body.
public EndpointSendConfiguration withBodyOverride(String bodyOverride)
The body of the message. If specified, this value overrides the default message body.
bodyOverride
- The body of the message. If specified, this value overrides the default message body.public Map<String,String> getContext()
A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
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.
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.
public void setContext(Map<String,String> context)
A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
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.
context
- A map of custom attributes to attach to the message for the address. Attribute names are case
sensitive.
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.
public EndpointSendConfiguration withContext(Map<String,String> context)
A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
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.
context
- A map of custom attributes to attach to the message for the address. Attribute names are case
sensitive.
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.
public EndpointSendConfiguration addContextEntry(String key, String value)
public EndpointSendConfiguration clearContextEntries()
public void setRawContent(String rawContent)
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
rawContent
- The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides
all other values for the message.public String getRawContent()
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
public EndpointSendConfiguration withRawContent(String rawContent)
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
rawContent
- The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides
all other values for the message.public Map<String,List<String>> getSubstitutions()
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
public void setSubstitutions(Map<String,List<String>> substitutions)
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
substitutions
- A map of the message variables to merge with the variables specified for the default message
(DefaultMessage.Substitutions). The variables specified in this map take precedence over all other
variables.public EndpointSendConfiguration withSubstitutions(Map<String,List<String>> substitutions)
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
substitutions
- A map of the message variables to merge with the variables specified for the default message
(DefaultMessage.Substitutions). The variables specified in this map take precedence over all other
variables.public EndpointSendConfiguration addSubstitutionsEntry(String key, List<String> value)
public EndpointSendConfiguration clearSubstitutionsEntries()
public void setTitleOverride(String titleOverride)
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
titleOverride
- The title or subject line of the message. If specified, this value overrides the default message title or
subject line.public String getTitleOverride()
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
public EndpointSendConfiguration withTitleOverride(String titleOverride)
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
titleOverride
- The title or subject line of the message. If specified, this value overrides the default message title or
subject line.public String toString()
toString
in class Object
Object.toString()
public EndpointSendConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.