software.amazon.awssdk.services.pinpoint.model

Class AddressConfiguration

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.AddressConfiguration

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<AddressConfiguration.Builder,AddressConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public class AddressConfiguration
extends Object
implements StructuredPojo, ToCopyableBuilder<AddressConfiguration.Builder,AddressConfiguration>

Address configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AddressConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
String	bodyOverride() Body override.
static AddressConfiguration.Builder	builder()
ChannelType	channelType() The channel type.
String	channelTypeAsString() The channel type.
Map<String,String>	context() A map of custom attributes to attributes to be attached to the message for this address.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	rawContent() The Raw JSON formatted string to be used as the payload.
static Class<? extends AddressConfiguration.Builder>	serializableBuilderClass()
Map<String,List<String>>	substitutions() A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
String	titleOverride() Title override.
AddressConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

bodyOverride

public String bodyOverride()

Body override. If specified will override default body.

Returns:

Body override. If specified will override default body.

channelType

public ChannelType channelType()

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

If the service returns an enum value that is not available in the current SDK version, channelType will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelTypeAsString().

Returns:

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

See Also:

ChannelType

channelTypeAsString

public String channelTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, channelType will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelTypeAsString().

Returns:

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

See Also:

ChannelType

context

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

rawContent

public String rawContent()

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.

substitutions

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

titleOverride

public String titleOverride()

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

Returns:

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

toBuilder

public AddressConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AddressConfiguration.Builder,AddressConfiguration>

Returns:

a builder for type T

builder

public static AddressConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends AddressConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.