Class InAppTemplateResponse
- java.lang.Object
-
- software.amazon.awssdk.services.pinpoint.model.InAppTemplateResponse
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<InAppTemplateResponse.Builder,InAppTemplateResponse>
@Generated("software.amazon.awssdk:codegen") public final class InAppTemplateResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InAppTemplateResponse.Builder,InAppTemplateResponse>
In-App Template Response.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceInAppTemplateResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The resource arn of the template.static InAppTemplateResponse.Builderbuilder()List<InAppMessageContent>content()The content of the message, can include up to 5 modals.StringcreationDate()The creation date of the template.Map<String,String>customConfig()Custom config to be sent to client.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasContent()For responses, this returns true if the service returned a value for the Content property.booleanhasCustomConfig()For responses, this returns true if the service returned a value for the CustomConfig property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringlastModifiedDate()The last modified date of the template.Layoutlayout()The layout of the message.StringlayoutAsString()The layout of the message.List<SdkField<?>>sdkFields()static Class<? extends InAppTemplateResponse.Builder>serializableBuilderClass()Map<String,String>tags()A string-to-string map of key-value pairs that defines the tags to associate with the message template.StringtemplateDescription()The description of the template.StringtemplateName()The name of the template.TemplateTypetemplateType()The type of the template.StringtemplateTypeAsString()The type of the template.InAppTemplateResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringversion()The version id of the template.-
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
-
arn
public final String arn()
The resource arn of the template.
- Returns:
- The resource arn of the template.
-
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 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.
-
content
public final List<InAppMessageContent> content()
The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
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:
- The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
-
creationDate
public final String creationDate()
The creation date of the template.
- Returns:
- The creation date of the template.
-
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 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.
-
customConfig
public final Map<String,String> customConfig()
Custom config to be sent to client.
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 client.
-
lastModifiedDate
public final String lastModifiedDate()
The last modified date of the template.
- Returns:
- The last modified date of the template.
-
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,
layoutwill returnLayout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlayoutAsString().- 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,
layoutwill returnLayout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlayoutAsString().- Returns:
- The layout of the message.
- See Also:
Layout
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final Map<String,String> tags()
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
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
hasTags()method.- Returns:
- A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
-
templateDescription
public final String templateDescription()
The description of the template.
- Returns:
- The description of the template.
-
templateName
public final String templateName()
The name of the template.
- Returns:
- The name of the template.
-
templateType
public final TemplateType templateType()
The type of the template.
If the service returns an enum value that is not available in the current SDK version,
templateTypewill returnTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtemplateTypeAsString().- Returns:
- The type of the template.
- See Also:
TemplateType
-
templateTypeAsString
public final String templateTypeAsString()
The type of the template.
If the service returns an enum value that is not available in the current SDK version,
templateTypewill returnTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtemplateTypeAsString().- Returns:
- The type of the template.
- See Also:
TemplateType
-
version
public final String version()
The version id of the template.
- Returns:
- The version id of the template.
-
toBuilder
public InAppTemplateResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<InAppTemplateResponse.Builder,InAppTemplateResponse>
-
builder
public static InAppTemplateResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends InAppTemplateResponse.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-