com.amazonaws.services.pinpoint.model

Class EndpointSendConfiguration

java.lang.Object

com.amazonaws.services.pinpoint.model.EndpointSendConfiguration

All Implemented Interfaces:

Serializable

public class EndpointSendConfiguration
extends Object
implements Serializable

Endpoint send configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EndpointSendConfiguration()

Method Summary

Modifier and Type	Method and Description
EndpointSendConfiguration	addContextEntry(String key, String value) A map of custom attributes to attributes to be attached to the message for this address.
EndpointSendConfiguration	addSubstitutionsEntry(String key, List<String> value) A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
EndpointSendConfiguration	clearContextEntries() Removes all the entries added into Context.
EndpointSendConfiguration	clearSubstitutionsEntries() Removes all the entries added into Substitutions.
boolean	equals(Object obj)
String	getBodyOverride() Body override.
Map<String,String>	getContext() A map of custom attributes to attributes to be attached to the message for this address.
String	getRawContent() The Raw JSON formatted string to be used as the payload.
Map<String,List<String>>	getSubstitutions() A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
String	getTitleOverride() Title override.
int	hashCode()
void	setBodyOverride(String bodyOverride) Body override.
void	setContext(Map<String,String> context) A map of custom attributes to attributes to be attached to the message for this address.
void	setRawContent(String rawContent) The Raw JSON formatted string to be used as the payload.
void	setSubstitutions(Map<String,List<String>> substitutions) A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
void	setTitleOverride(String titleOverride) Title override.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EndpointSendConfiguration	withBodyOverride(String bodyOverride) Body override.
EndpointSendConfiguration	withContext(Map<String,String> context) A map of custom attributes to attributes to be attached to the message for this address.
EndpointSendConfiguration	withRawContent(String rawContent) The Raw JSON formatted string to be used as the payload.
EndpointSendConfiguration	withSubstitutions(Map<String,List<String>> substitutions) A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
EndpointSendConfiguration	withTitleOverride(String titleOverride) Title override.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EndpointSendConfiguration

public EndpointSendConfiguration()

Method Detail

getBodyOverride

public String getBodyOverride()

Body override. If specified will override default body.

Returns:

Body override. If specified will override default body.

setBodyOverride

public void setBodyOverride(String bodyOverride)

Body override. If specified will override default body.

Parameters:

bodyOverride - Body override. If specified will override default body.

withBodyOverride

public EndpointSendConfiguration withBodyOverride(String bodyOverride)

Body override. If specified will override default body.

Returns a reference to this object so that method calls can be chained together.

Parameters:

bodyOverride - Body override. If specified will override default body.

Returns:

A reference to this updated 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 for this address. 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 for this address. 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 for this address. 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 for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

withContext

public EndpointSendConfiguration withContext(Map<String,String> context)

A map of custom attributes to attributes to be attached to the message for this address. 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 for this address. 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 EndpointSendConfiguration addContextEntry(String key,
                                                 String value)

A map of custom attributes to attributes to be attached to the message for this address. 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 EndpointSendConfiguration clearContextEntries()

Removes all the entries added into Context.

Returns a reference to this object so that method calls can be chained together.

getRawContent

public String getRawContent()

The Raw JSON formatted string to be used as the payload. This value overrides the message.

Returns:

The Raw JSON formatted string to be used as the payload. This value overrides the message.

setRawContent

public void setRawContent(String rawContent)

The Raw JSON formatted string to be used as the payload. This value overrides the message.

Parameters:

rawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.

withRawContent

public EndpointSendConfiguration withRawContent(String rawContent)

The Raw JSON formatted string to be used as the payload. This value overrides the message.

Returns a reference to this object so that method calls can be chained together.

Parameters:

rawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.

Returns:

A reference to this updated object so that method calls can be chained together.

getSubstitutions

public Map<String,List<String>> getSubstitutions()

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

Returns:

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

setSubstitutions

public void setSubstitutions(Map<String,List<String>> substitutions)

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

Parameters:

substitutions - A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

withSubstitutions

public EndpointSendConfiguration withSubstitutions(Map<String,List<String>> substitutions)

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

Returns a reference to this object so that method calls can be chained together.

Parameters:

substitutions - A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

Returns:

A reference to this updated object so that method calls can be chained together.

addSubstitutionsEntry

public EndpointSendConfiguration addSubstitutionsEntry(String key,
                                                       List<String> value)

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

The method adds a new key-value pair into Substitutions 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 Substitutions.

value - The corresponding value of the entry to be added into Substitutions.

Returns:

A reference to this updated object so that method calls can be chained together.

clearSubstitutionsEntries

public EndpointSendConfiguration clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

Returns a reference to this object so that method calls can be chained together.

getTitleOverride

public String getTitleOverride()

Title override. If specified will override default title if applicable.

Returns:

Title override. If specified will override default title if applicable.

setTitleOverride

public void setTitleOverride(String titleOverride)

Title override. If specified will override default title if applicable.

Parameters:

titleOverride - Title override. If specified will override default title if applicable.

withTitleOverride

public EndpointSendConfiguration withTitleOverride(String titleOverride)

Title override. If specified will override default title if applicable.

Returns a reference to this object so that method calls can be chained together.

Parameters:

titleOverride - Title override. If specified will override default title if applicable.

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