software.amazon.awssdk.services.pinpoint.model

Class DefaultMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.DefaultMessage

All Implemented Interfaces:

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

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

Specifies the default message for all channels.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultMessage.Builder

Method Summary

Modifier and Type	Method and Description
String	body() The default body of the message.
static DefaultMessage.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubstitutions() For responses, this returns true if the service returned a value for the Substitutions property.
List<SdkField<?>>	sdkFields()
static Class<? extends DefaultMessage.Builder>	serializableBuilderClass()
Map<String,List<String>>	substitutions() The default message variables to use in the message.
DefaultMessage.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

body

public final String body()

The default body of the message.

Returns:

The default body of 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()

The default message variables to use in the message. You can override these default variables with individual address 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:

The default message variables to use in the message. You can override these default variables with individual address variables.

toBuilder

public DefaultMessage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultMessage.Builder,DefaultMessage>

builder

public static DefaultMessage.Builder builder()

serializableBuilderClass

public static Class<? extends DefaultMessage.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