java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.InAppTemplateRequest

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<InAppTemplateRequest.Builder,InAppTemplateRequest>

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

InApp Template Request.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InAppTemplateRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static InAppTemplateRequest.Builder`	`builder()`
`List<InAppMessageContent>`	`content()`	The content of the message, can include up to 5 modals.
`Map<String,String>`	`customConfig()`	Custom config to be sent to client.
`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()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Layout`	`layout()`	The layout of the message.
`String`	`layoutAsString()`	The layout of the message.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InAppTemplateRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`
`String`	`templateDescription()`	The description of the template.
`InAppTemplateRequest.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()
```
    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.
  - 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 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.
  - 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
  - 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 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.
  - tags
```
public final Map<String,String> tags()
```
    As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
    
    (Deprecated) 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:
    
    As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
  - templateDescription
```
public final String templateDescription()
```
    The description of the template.
    
    Returns:
    
    The description of the template.
  - toBuilder
```
public InAppTemplateRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InAppTemplateRequest.Builder,InAppTemplateRequest>
  - builder
```
public static InAppTemplateRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InAppTemplateRequest.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

Class InAppTemplateRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasContent

content

hasCustomConfig

customConfig

layout

layoutAsString

hasTags

tags

templateDescription

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields