Package software.amazon.awssdk.services.pinpoint.model

Class AddressConfiguration

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AddressConfiguration.Builder,AddressConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class AddressConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AddressConfiguration.Builder,AddressConfiguration>

Specifies address-based configuration settings for a message that's sent directly to an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AddressConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
String	bodyOverride()	The message body to use instead of the default message body.
static AddressConfiguration.Builder	builder()
ChannelType	channelType()	The channel to use when sending the message.
String	channelTypeAsString()	The channel to use when sending the message.
Map<String,String>	context()	An object that maps custom attributes to attributes for the address and is attached to the message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContext()	For responses, this returns true if the service returned a value for the Context property.
int	hashCode()
boolean	hasSubstitutions()	For responses, this returns true if the service returned a value for the Substitutions property.
String	rawContent()	The raw, JSON-formatted string to use as the payload for the message.
List<SdkField<?>>	sdkFields()
static Class<? extends AddressConfiguration.Builder>	serializableBuilderClass()
Map<String,List<String>>	substitutions()	A map of the message variables to merge with the variables specified by properties of the DefaultMessage object.
String	titleOverride()	The message title to use instead of the default message title.
AddressConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

bodyOverride

public final String bodyOverride()

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.

channelType

public final ChannelType channelType()

The channel to use when sending the message.

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 to use when sending the message.

See Also:

ChannelType

channelTypeAsString

public final String channelTypeAsString()

The channel to use when sending the message.

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 to use when sending the message.

See Also:

ChannelType

hasContext

public final boolean hasContext()

For responses, this returns true if the service returned a value for the Context property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

context

public final Map<String,String> context()

An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

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.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContext() method.

Returns:

An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

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.

rawContent

public final String rawContent()

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

Returns:

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

hasSubstitutions

public final boolean hasSubstitutions()

For responses, this returns true if the service returned a value for the Substitutions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

substitutions

public final Map<String,List<String>> substitutions()

A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubstitutions() method.

Returns:

A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

titleOverride

public final String titleOverride()

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.

toBuilder

public AddressConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AddressConfiguration.Builder,AddressConfiguration>

builder

public static AddressConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo