com.amazonaws.services.pinpoint.model

Class InAppTemplateRequest

java.lang.Object

com.amazonaws.services.pinpoint.model.InAppTemplateRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InAppTemplateRequest
extends Object
implements Serializable, Cloneable, StructuredPojo

InApp Template Request.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
InAppTemplateRequest()

Method Summary

Modifier and Type	Method and Description
InAppTemplateRequest	addCustomConfigEntry(String key, String value) Add a single CustomConfig entry
InAppTemplateRequest	addTagsEntry(String key, String value) Add a single Tags entry
InAppTemplateRequest	clearCustomConfigEntries() Removes all the entries added into CustomConfig.
InAppTemplateRequest	clearTagsEntries() Removes all the entries added into Tags.
InAppTemplateRequest	clone()
boolean	equals(Object obj)
List<InAppMessageContent>	getContent() The content of the message, can include up to 5 modals.
Map<String,String>	getCustomConfig() Custom config to be sent to client.
String	getLayout() The layout of the message.
Map<String,String>	getTags()
String	getTemplateDescription() The description of the template.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContent(Collection<InAppMessageContent> content) The content of the message, can include up to 5 modals.
void	setCustomConfig(Map<String,String> customConfig) Custom config to be sent to client.
void	setLayout(String layout) The layout of the message.
void	setTags(Map<String,String> tags)
void	setTemplateDescription(String templateDescription) The description of the template.
String	toString() Returns a string representation of this object.
InAppTemplateRequest	withContent(Collection<InAppMessageContent> content) The content of the message, can include up to 5 modals.
InAppTemplateRequest	withContent(InAppMessageContent... content) The content of the message, can include up to 5 modals.
InAppTemplateRequest	withCustomConfig(Map<String,String> customConfig) Custom config to be sent to client.
InAppTemplateRequest	withLayout(Layout layout) The layout of the message.
InAppTemplateRequest	withLayout(String layout) The layout of the message.
InAppTemplateRequest	withTags(Map<String,String> tags)
InAppTemplateRequest	withTemplateDescription(String templateDescription) The description of the template.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InAppTemplateRequest

public InAppTemplateRequest()

Method Detail

getContent

public List<InAppMessageContent> getContent()

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.

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.

setContent

public void setContent(Collection<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.

Parameters:

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.

withContent

public InAppTemplateRequest withContent(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.

NOTE: This method appends the values to the existing list (if any). Use setContent(java.util.Collection) or withContent(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withContent

public InAppTemplateRequest withContent(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCustomConfig

public Map<String,String> getCustomConfig()

Custom config to be sent to client.

Returns:

Custom config to be sent to client.

setCustomConfig

public void setCustomConfig(Map<String,String> customConfig)

Custom config to be sent to client.

Parameters:

customConfig - Custom config to be sent to client.

withCustomConfig

public InAppTemplateRequest withCustomConfig(Map<String,String> customConfig)

Custom config to be sent to client.

Parameters:

customConfig - Custom config to be sent to client.

Returns:

Returns a reference to this object so that method calls can be chained together.

addCustomConfigEntry

public InAppTemplateRequest addCustomConfigEntry(String key,
                                                 String value)

Add a single CustomConfig entry

See Also:

withCustomConfig(java.util.Map<java.lang.String, java.lang.String>)

clearCustomConfigEntries

public InAppTemplateRequest clearCustomConfigEntries()

Removes all the entries added into CustomConfig.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLayout

public void setLayout(String layout)

The layout of the message.

Parameters:

layout - The layout of the message.

See Also:

Layout

getLayout

public String getLayout()

The layout of the message.

Returns:

The layout of the message.

See Also:

Layout

withLayout

public InAppTemplateRequest withLayout(String layout)

The layout of the message.

Parameters:

layout - The layout of the message.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Layout

withLayout

public InAppTemplateRequest withLayout(Layout layout)

The layout of the message.

Parameters:

layout - The layout of the message.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Layout

getTags

public Map<String,String> getTags()

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.

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.

setTags

public void setTags(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.

Parameters:

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.

withTags

public InAppTemplateRequest withTags(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public InAppTemplateRequest addTagsEntry(String key,
                                         String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public InAppTemplateRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTemplateDescription

public void setTemplateDescription(String templateDescription)

The description of the template.

Parameters:

templateDescription - The description of the template.

getTemplateDescription

public String getTemplateDescription()

The description of the template.

Returns:

The description of the template.

withTemplateDescription

public InAppTemplateRequest withTemplateDescription(String templateDescription)

The description of the template.

Parameters:

templateDescription - The description of the template.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public InAppTemplateRequest clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.