software.amazon.awssdk.services.pinpoint.model

Interface InAppTemplateRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InAppTemplateRequest.Builder,InAppTemplateRequest>, SdkBuilder<InAppTemplateRequest.Builder,InAppTemplateRequest>, SdkPojo

Enclosing class:

InAppTemplateRequest

public static interface InAppTemplateRequest.Builder
extends SdkPojo, CopyableBuilder<InAppTemplateRequest.Builder,InAppTemplateRequest>

Method Summary

Modifier and Type	Method and Description
InAppTemplateRequest.Builder	content(Collection<InAppMessageContent> content) The content of the message, can include up to 5 modals.
InAppTemplateRequest.Builder	content(Consumer<InAppMessageContent.Builder>... content) The content of the message, can include up to 5 modals.
InAppTemplateRequest.Builder	content(InAppMessageContent... content) The content of the message, can include up to 5 modals.
InAppTemplateRequest.Builder	customConfig(Map<String,String> customConfig) Custom config to be sent to client.
InAppTemplateRequest.Builder	layout(Layout layout) The layout of the message.
InAppTemplateRequest.Builder	layout(String layout) The layout of the message.
InAppTemplateRequest.Builder	tags(Map<String,String> tags)
InAppTemplateRequest.Builder	templateDescription(String templateDescription) The description of the template.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

content

InAppTemplateRequest.Builder content(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.

content

InAppTemplateRequest.Builder content(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.

content

InAppTemplateRequest.Builder content(Consumer<InAppMessageContent.Builder>... 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.

This is a convenience method that creates an instance of the InAppMessageContent.Builder avoiding the need to create one manually via InAppMessageContent.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #content(List).

Parameters:

content - a consumer that will call methods on InAppMessageContent.Builder

Returns:

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

See Also:

#content(java.util.Collection)

customConfig

InAppTemplateRequest.Builder customConfig(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.

layout

InAppTemplateRequest.Builder layout(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, Layout

layout

InAppTemplateRequest.Builder layout(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, Layout

tags

InAppTemplateRequest.Builder tags(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.

templateDescription

InAppTemplateRequest.Builder templateDescription(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.