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

Class InAppMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.InAppMessage

All Implemented Interfaces:

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

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

Provides all fields required for building an in-app message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InAppMessage.Builder

Method Summary

Modifier and Type	Method	Description
static InAppMessage.Builder	builder()
List<InAppMessageContent>	content()	In-app message content.
Map<String,String>	customConfig()	Custom config to be sent to SDK.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContent()	For responses, this returns true if the service returned a value for the Content property.
boolean	hasCustomConfig()	For responses, this returns true if the service returned a value for the CustomConfig property.
int	hashCode()
Layout	layout()	The layout of the message.
String	layoutAsString()	The layout of the message.
List<SdkField<?>>	sdkFields()
static Class<? extends InAppMessage.Builder>	serializableBuilderClass()
InAppMessage.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

hasContent

public final boolean hasContent()

For responses, this returns true if the service returned a value for the Content 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.

content

public final List<InAppMessageContent> content()

In-app message content.

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 hasContent() method.

Returns:

In-app message content.

hasCustomConfig

public final boolean hasCustomConfig()

For responses, this returns true if the service returned a value for the CustomConfig 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.

customConfig

public final Map<String,String> customConfig()

Custom config to be sent to SDK.

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 hasCustomConfig() method.

Returns:

Custom config to be sent to SDK.

layout

public final Layout layout()

The layout of the message.

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

Returns:

The layout of the message.

See Also:

Layout

layoutAsString

public final String layoutAsString()

The layout of the message.

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

Returns:

The layout of the message.

See Also:

Layout

toBuilder

public InAppMessage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InAppMessage.Builder,InAppMessage>

builder

public static InAppMessage.Builder builder()

serializableBuilderClass

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