EndpointSendConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.EndpointSendConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Endpoint send configuration.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EndpointSendConfiguration()

Constructors
Constructor and Description
`EndpointSendConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EndpointSendConfiguration`	`addContextEntry(String key, String value)`
`EndpointSendConfiguration`	`addSubstitutionsEntry(String key, List<String> value)`
`EndpointSendConfiguration`	`clearContextEntries()` Removes all the entries added into Context.
`EndpointSendConfiguration`	`clearSubstitutionsEntries()` Removes all the entries added into Substitutions.
`EndpointSendConfiguration`	`clone()`
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EndpointSendConfiguration
```
public EndpointSendConfiguration()
```
- 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 EndpointSendConfiguration 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.
  - 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.
    
    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 EndpointSendConfiguration addContextEntry(String key,
                                                 String value)
```
  - clearContextEntries
```
public EndpointSendConfiguration 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 EndpointSendConfiguration 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 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.
    
    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 EndpointSendConfiguration addSubstitutionsEntry(String key,
                                                       List<String> value)
```
  - clearSubstitutionsEntries
```
public EndpointSendConfiguration 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 EndpointSendConfiguration 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 EndpointSendConfiguration 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.

Did this page help you?

Class EndpointSendConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointSendConfiguration

Method Detail

setBodyOverride

getBodyOverride

withBodyOverride

getContext

setContext

withContext

addContextEntry

clearContextEntries

setRawContent

getRawContent

withRawContent

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

setTitleOverride

getTitleOverride

withTitleOverride

toString

equals

hashCode

clone

marshall