AddressConfiguration (AWS Java SDK for Amazon Pinpoint 1.11.594 API)

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
```
Specifies address-based configuration settings for a message that's sent directly to an endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AddressConfiguration()

Constructors
Constructor and Description
`AddressConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` 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 notification message.
`Map<String,List<String>>`	`getSubstitutions()` An object that maps variable values for the message.
`String`	`getTitleOverride()` The message title to use instead of the default message title.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller 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 notification message.
`void`	`setSubstitutions(Map<String,List<String>> substitutions)` An object that maps variable values for the message.
`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 notification message.
`AddressConfiguration`	`withSubstitutions(Map<String,List<String>> substitutions)` An object that maps variable values for the message.
`AddressConfiguration`	`withTitleOverride(String titleOverride)` The message title to use instead of the default message title.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AddressConfiguration
```
public AddressConfiguration()
```
- Method Detail
  - setBodyOverride
```
public void setBodyOverride(String bodyOverride)
```
    The message body to use instead of the default message body. This value overrides the default message body.
    
    Parameters:
    
    bodyOverride - The message body to use instead of the default message body. This value overrides the default message body.
  - getBodyOverride
```
public String getBodyOverride()
```
    The message body to use instead of the default message body. This value overrides the default message body.
    
    Returns:
    
    The message body to use instead of the default message body. This value overrides the default message body.
  - withBodyOverride
```
public AddressConfiguration withBodyOverride(String bodyOverride)
```
    The message body to use instead of the default message body. This value overrides the default message body.
    
    Parameters:
    
    bodyOverride - The message body to use instead of the default message body. This value overrides the default message body.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannelType
```
public void setChannelType(String channelType)
```
    The channel to use when sending the message.
    
    Parameters:
    
    channelType - The channel to use when sending the message.
    
    See Also:
    
    ChannelType
  - getChannelType
```
public String getChannelType()
```
    The channel to use when sending the message.
    
    Returns:
    
    The channel to use when sending the message.
    
    See Also:
    
    ChannelType
  - withChannelType
```
public AddressConfiguration withChannelType(String channelType)
```
    The channel to use when sending the message.
    
    Parameters:
    
    channelType - The channel to use when sending the message.
    
    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 to use when sending the message.
    
    Parameters:
    
    channelType - The channel to use when sending the message.
    
    See Also:
    
    ChannelType
  - withChannelType
```
public AddressConfiguration withChannelType(ChannelType channelType)
```
    The channel to use when sending the message.
    
    Parameters:
    
    channelType - The channel to use when sending the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - getContext
```
public Map<String,String> getContext()
```
    An object that maps custom attributes to attributes for the address and is attached to the message. 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.
    
    Returns:
    
    An object that maps custom attributes to attributes for the address and is attached to the message. 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.
  - setContext
```
public void setContext(Map<String,String> context)
```
    An object that maps custom attributes to attributes for the address and is attached to the message. 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.
    
    Parameters:
    
    context - An object that maps custom attributes to attributes for the address and is attached to the message. 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.
  - withContext
```
public AddressConfiguration withContext(Map<String,String> context)
```
    An object that maps custom attributes to attributes for the address and is attached to the message. 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.
    
    Parameters:
    
    context - An object that maps custom attributes to attributes for the address and is attached to the message. 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.
    
    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 use as the payload for the notification message. This value overrides the message.
    
    Parameters:
    
    rawContent - The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
  - getRawContent
```
public String getRawContent()
```
    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
    
    Returns:
    
    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
  - withRawContent
```
public AddressConfiguration withRawContent(String rawContent)
```
    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
    
    Parameters:
    
    rawContent - The raw, JSON-formatted string to use as the payload for the notification message. 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()
```
    An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.
    
    Returns:
    
    An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.
  - setSubstitutions
```
public void setSubstitutions(Map<String,List<String>> substitutions)
```
    An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.
    
    Parameters:
    
    substitutions - An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.
  - withSubstitutions
```
public AddressConfiguration withSubstitutions(Map<String,List<String>> substitutions)
```
    An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.
    
    Parameters:
    
    substitutions - An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over 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)
```
    The message title to use instead of the default message title. This value overrides the default message title.
    
    Parameters:
    
    titleOverride - The message title to use instead of the default message title. This value overrides the default message title.
  - getTitleOverride
```
public String getTitleOverride()
```
    The message title to use instead of the default message title. This value overrides the default message title.
    
    Returns:
    
    The message title to use instead of the default message title. This value overrides the default message title.
  - withTitleOverride
```
public AddressConfiguration withTitleOverride(String titleOverride)
```
    The message title to use instead of the default message title. This value overrides the default message title.
    
    Parameters:
    
    titleOverride - The message title to use instead of the default message title. This value overrides the default message title.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AddressConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AddressConfiguration

Method Detail

setBodyOverride

getBodyOverride

withBodyOverride

setChannelType

getChannelType

withChannelType

setChannelType

withChannelType

getContext

setContext

withContext

addContextEntry

clearContextEntries

setRawContent

getRawContent

withRawContent

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

setTitleOverride

getTitleOverride

withTitleOverride

toString

equals

hashCode

clone

marshall