Class AddressConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AddressConfiguration.Builder,
AddressConfiguration>
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The message body to use instead of the default message body.static AddressConfiguration.Builder
builder()
final ChannelType
The channel to use when sending the message.final String
The channel to use when sending the message.context()
An object that maps custom attributes to attributes for the address and is attached to the message.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Context property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Substitutions property.final String
The raw, JSON-formatted string to use as the payload for the message.static Class
<? extends AddressConfiguration.Builder> A map of the message variables to merge with the variables specified by properties of the DefaultMessage object.final String
The message title to use instead of the default message title.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnChannelType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchannelTypeAsString()
.- Returns:
- The channel to use when sending the message.
- See Also:
-
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 returnChannelType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchannelTypeAsString()
.- Returns:
- The channel to use when sending the message.
- See Also:
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<AddressConfiguration.Builder,
AddressConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-