com.amazonaws.services.pinpoint.model

Class AddressConfiguration

java.lang.Object

com.amazonaws.services.pinpoint.model.AddressConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AddressConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Address configuration.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AddressConfiguration()

Method Summary

Modifier and Type	Method and Description
AddressConfiguration	addContextEntry(String key, String value)
AddressConfiguration	addSubstitutionsEntry(String key, List<String> value)
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() Body override.
String	getChannelType() The channel type.
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	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBodyOverride(String bodyOverride) Body override.
void	setChannelType(ChannelType channelType) The channel type.
void	setChannelType(String channelType) The channel type.
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.
AddressConfiguration	withBodyOverride(String bodyOverride) Body override.
AddressConfiguration	withChannelType(ChannelType channelType) The channel type.
AddressConfiguration	withChannelType(String channelType) The channel type.
AddressConfiguration	withContext(Map<String,String> context) A map of custom attributes to attributes to be attached to the message for this address.
AddressConfiguration	withRawContent(String rawContent) The Raw JSON formatted string to be used as the payload.
AddressConfiguration	withSubstitutions(Map<String,List<String>> substitutions) A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
AddressConfiguration	withTitleOverride(String titleOverride) Title override.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AddressConfiguration

public AddressConfiguration()

Method Detail

setBodyOverride

public void setBodyOverride(String bodyOverride)

Body override. If specified will override default body.

Parameters:

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

getBodyOverride

public String getBodyOverride()

Body override. If specified will override default body.

Returns:

Body override. If specified will override default body.

withBodyOverride

public AddressConfiguration withBodyOverride(String bodyOverride)

Body override. If specified will override default body.

Parameters:

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

Returns:

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

setChannelType

public void setChannelType(String channelType)

The channel type. Valid values: GCM | APNS | SMS | EMAIL

Parameters:

channelType - The channel type. Valid values: GCM | APNS | SMS | EMAIL

See Also:

ChannelType

getChannelType

public String getChannelType()

The channel type. Valid values: GCM | APNS | SMS | EMAIL

Returns:

The channel type. Valid values: GCM | APNS | SMS | EMAIL

See Also:

ChannelType

withChannelType

public AddressConfiguration withChannelType(String channelType)

The channel type. Valid values: GCM | APNS | SMS | EMAIL

Parameters:

channelType - The channel type. Valid values: GCM | APNS | SMS | EMAIL

Returns:

Returns a reference to this 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 | SMS | EMAIL

Parameters:

channelType - The channel type. Valid values: GCM | APNS | SMS | EMAIL

See Also:

ChannelType

withChannelType

public AddressConfiguration withChannelType(ChannelType channelType)

The channel type. Valid values: GCM | APNS | SMS | EMAIL

Parameters:

channelType - The channel type. Valid values: GCM | APNS | SMS | EMAIL

Returns:

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

See Also:

ChannelType

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 AddressConfiguration 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.

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:

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

addContextEntry

public AddressConfiguration addContextEntry(String key,
                                            String value)

clearContextEntries

public AddressConfiguration clearContextEntries()

Removes all the entries added into Context.

Returns:

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

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.

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.

withRawContent

public AddressConfiguration withRawContent(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.

Returns:

Returns a reference to this 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 AddressConfiguration 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.

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:

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

addSubstitutionsEntry

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

clearSubstitutionsEntries

public AddressConfiguration clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

Returns:

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

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.

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.

withTitleOverride

public AddressConfiguration withTitleOverride(String titleOverride)

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

Parameters:

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

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 AddressConfiguration 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.