@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AddressConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
Constructor and Description |
---|
AddressConfiguration() |
Modifier and Type | Method and Description |
---|---|
AddressConfiguration |
addContextEntry(String key,
String value)
Add a single Context entry
|
AddressConfiguration |
addSubstitutionsEntry(String key,
List<String> value)
Add a single Substitutions entry
|
AddressConfiguration |
clearContextEntries()
Removes all the entries added into Context.
|
AddressConfiguration |
clearSubstitutionsEntries()
Removes all the entries added into Substitutions.
|
AddressConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getBodyOverride()
The message body to use instead of the default message body.
|
String |
getChannelType()
The channel to use when sending the message.
|
Map<String,String> |
getContext()
An object that maps custom attributes to attributes for the address and is attached to the message.
|
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 by properties of the DefaultMessage object.
|
String |
getTitleOverride()
The message title to use instead of the default message title.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBodyOverride(String bodyOverride)
The message body to use instead of the default message body.
|
void |
setChannelType(ChannelType channelType)
The channel to use when sending the message.
|
void |
setChannelType(String channelType)
The channel to use when sending the message.
|
void |
setContext(Map<String,String> context)
An object that maps custom attributes to attributes for the address and is attached to the message.
|
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 by properties of the DefaultMessage object.
|
void |
setTitleOverride(String titleOverride)
The message title to use instead of the default message title.
|
String |
toString()
Returns a string representation of this object.
|
AddressConfiguration |
withBodyOverride(String bodyOverride)
The message body to use instead of the default message body.
|
AddressConfiguration |
withChannelType(ChannelType channelType)
The channel to use when sending the message.
|
AddressConfiguration |
withChannelType(String channelType)
The channel to use when sending the message.
|
AddressConfiguration |
withContext(Map<String,String> context)
An object that maps custom attributes to attributes for the address and is attached to the message.
|
AddressConfiguration |
withRawContent(String rawContent)
The raw, JSON-formatted string to use as the payload for the message.
|
AddressConfiguration |
withSubstitutions(Map<String,List<String>> substitutions)
A map of the message variables to merge with the variables specified by properties of the DefaultMessage object.
|
AddressConfiguration |
withTitleOverride(String titleOverride)
The message title to use instead of the default message title.
|
public void setBodyOverride(String bodyOverride)
The message body to use instead of the default message body. This value overrides the default message body.
bodyOverride
- The message body to use instead of the default message body. This value overrides the default message
body.public String getBodyOverride()
The message body to use instead of the default message body. This value overrides the default message body.
public AddressConfiguration withBodyOverride(String bodyOverride)
The message body to use instead of the default message body. This value overrides the default message body.
bodyOverride
- The message body to use instead of the default message body. This value overrides the default message
body.public void setChannelType(String channelType)
The channel to use when sending the message.
channelType
- The channel to use when sending the message.ChannelType
public String getChannelType()
The channel to use when sending the message.
ChannelType
public AddressConfiguration withChannelType(String channelType)
The channel to use when sending the message.
channelType
- The channel to use when sending the message.ChannelType
public void setChannelType(ChannelType channelType)
The channel to use when sending the message.
channelType
- The channel to use when sending the message.ChannelType
public AddressConfiguration withChannelType(ChannelType channelType)
The channel to use when sending the message.
channelType
- The channel to use when sending the message.ChannelType
public Map<String,String> getContext()
An object that maps custom attributes to attributes for the address and is attached to the message. 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)
An object that maps custom attributes to attributes for the address and is attached to the message. 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
- An object that maps custom attributes to attributes for the address and is attached to the message.
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 AddressConfiguration withContext(Map<String,String> context)
An object that maps custom attributes to attributes for the address and is attached to the message. 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
- An object that maps custom attributes to attributes for the address and is attached to the message.
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 AddressConfiguration addContextEntry(String key, String value)
public AddressConfiguration 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 AddressConfiguration 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 by properties of the DefaultMessage object. 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 by properties of the DefaultMessage object. 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 by properties of the DefaultMessage
object. The variables specified in this map take precedence over all other variables.public AddressConfiguration withSubstitutions(Map<String,List<String>> substitutions)
A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. 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 by properties of the DefaultMessage
object. The variables specified in this map take precedence over all other variables.public AddressConfiguration addSubstitutionsEntry(String key, List<String> value)
public AddressConfiguration clearSubstitutionsEntries()
public void setTitleOverride(String titleOverride)
The message title to use instead of the default message title. This value overrides the default message title.
titleOverride
- The message title to use instead of the default message title. This value overrides the default message
title.public String getTitleOverride()
The message title to use instead of the default message title. This value overrides the default message title.
public AddressConfiguration withTitleOverride(String titleOverride)
The message title to use instead of the default message title. This value overrides the default message title.
titleOverride
- The message title to use instead of the default message title. This value overrides the default message
title.public String toString()
toString
in class Object
Object.toString()
public AddressConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.