Class InAppTemplateResponse
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InAppTemplateResponse.Builder,
InAppTemplateResponse>
In-App Template Response.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The resource arn of the template.builder()
final List
<InAppMessageContent> content()
The content of the message, can include up to 5 modals.final String
The creation date of the template.Custom config to be sent to client.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 Content property.final boolean
For responses, this returns true if the service returned a value for the CustomConfig property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The last modified date of the template.final Layout
layout()
The layout of the message.final String
The layout of the message.static Class
<? extends InAppTemplateResponse.Builder> tags()
A string-to-string map of key-value pairs that defines the tags to associate with the message template.final String
The description of the template.final String
The name of the template.final TemplateType
The type of the template.final String
The type of the template.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.final String
version()
The version id of the template.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
The last modified date of the template.
- Returns:
- The last modified date of the template.
-
layout
The layout of the message.
If the service returns an enum value that is not available in the current SDK version,
layout
will returnLayout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlayoutAsString()
.- Returns:
- The layout of the message.
- See Also:
-
layoutAsString
The layout of the message.
If the service returns an enum value that is not available in the current SDK version,
layout
will returnLayout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlayoutAsString()
.- Returns:
- The layout of the message.
- See Also:
-
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
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
The description of the template.
- Returns:
- The description of the template.
-
templateName
The name of the template.
- Returns:
- The name of the template.
-
templateType
The type of the template.
If the service returns an enum value that is not available in the current SDK version,
templateType
will returnTemplateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtemplateTypeAsString()
.- Returns:
- The type of the template.
- See Also:
-
templateTypeAsString
The type of the template.
If the service returns an enum value that is not available in the current SDK version,
templateType
will returnTemplateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtemplateTypeAsString()
.- Returns:
- The type of the template.
- See Also:
-
version
The version id of the template.
- Returns:
- The version id of the template.
-
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<InAppTemplateResponse.Builder,
InAppTemplateResponse> - 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
-