com.amazonaws.services.pinpoint.model

Class AddressConfiguration

java.lang.Object

com.amazonaws.services.pinpoint.model.AddressConfiguration

All Implemented Interfaces:

java.io.Serializable

public class AddressConfiguration
extends java.lang.Object
implements java.io.Serializable

Address configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AddressConfiguration()

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AddressConfiguration

public AddressConfiguration()

Method Detail

getBodyOverride

public java.lang.String getBodyOverride()

Body override. If specified will override default body.

Returns:

Body override. If specified will override default body.

setBodyOverride

public void setBodyOverride(java.lang.String bodyOverride)

Body override. If specified will override default body.

Parameters:

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

withBodyOverride

public AddressConfiguration withBodyOverride(java.lang.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.

getChannelType

public java.lang.String getChannelType()

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

Returns:

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

See Also:

ChannelType

setChannelType

public void setChannelType(java.lang.String channelType)

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

Parameters:

channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

See Also:

ChannelType

withChannelType

public AddressConfiguration withChannelType(java.lang.String channelType)

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

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

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

Parameters:

channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Returns:

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

See Also:

ChannelType

setChannelType

public void setChannelType(ChannelType channelType)

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

Parameters:

channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

See Also:

ChannelType

withChannelType

public AddressConfiguration withChannelType(ChannelType channelType)

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

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

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

Parameters:

channelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Returns:

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

See Also:

ChannelType

getContext

public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 AddressConfiguration withContext(java.util.Map<java.lang.String,java.lang.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 AddressConfiguration addContextEntry(java.lang.String key,
                                            java.lang.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 AddressConfiguration clearContextEntries()

Removes all the entries added into Context.

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

getRawContent

public java.lang.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(java.lang.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 AddressConfiguration withRawContent(java.lang.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 java.util.Map<java.lang.String,java.util.List<java.lang.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(java.util.Map<java.lang.String,java.util.List<java.lang.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 AddressConfiguration withSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.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 AddressConfiguration addSubstitutionsEntry(java.lang.String key,
                                                  java.util.List<java.lang.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 AddressConfiguration clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

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

getTitleOverride

public java.lang.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(java.lang.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 AddressConfiguration withTitleOverride(java.lang.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 java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object