Interface CreateCustomActionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ChatbotRequest.Builder, CopyableBuilder<CreateCustomActionRequest.Builder,CreateCustomActionRequest>, SdkBuilder<CreateCustomActionRequest.Builder,CreateCustomActionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateCustomActionRequest

@Mutable
@NotThreadSafe
public static interface CreateCustomActionRequest.Builder
extends ChatbotRequest.Builder, SdkPojo, CopyableBuilder<CreateCustomActionRequest.Builder,CreateCustomActionRequest>

Method Summary

Modifier and Type	Method	Description
CreateCustomActionRequest.Builder	actionName(String actionName)	The name of the custom action.
CreateCustomActionRequest.Builder	aliasName(String aliasName)	The name used to invoke this action in a chat channel.
CreateCustomActionRequest.Builder	attachments(Collection<CustomActionAttachment> attachments)	Defines when this custom action button should be attached to a notification.
CreateCustomActionRequest.Builder	attachments(Consumer<CustomActionAttachment.Builder>... attachments)	Defines when this custom action button should be attached to a notification.
CreateCustomActionRequest.Builder	attachments(CustomActionAttachment... attachments)	Defines when this custom action button should be attached to a notification.
CreateCustomActionRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default CreateCustomActionRequest.Builder	definition(Consumer<CustomActionDefinition.Builder> definition)	The definition of the command to run when invoked as an alias or as an action button.
CreateCustomActionRequest.Builder	definition(CustomActionDefinition definition)	The definition of the command to run when invoked as an alias or as an action button.
CreateCustomActionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateCustomActionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateCustomActionRequest.Builder	tags(Collection<Tag> tags)	A map of tags assigned to a resource.
CreateCustomActionRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A map of tags assigned to a resource.
CreateCustomActionRequest.Builder	tags(Tag... tags)	A map of tags assigned to a resource.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.chatbot.model.ChatbotRequest.Builder

build

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

definition

CreateCustomActionRequest.Builder definition(CustomActionDefinition definition)

The definition of the command to run when invoked as an alias or as an action button.

Parameters:

definition - The definition of the command to run when invoked as an alias or as an action button.

Returns:

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

definition

default CreateCustomActionRequest.Builder definition(Consumer<CustomActionDefinition.Builder> definition)

The definition of the command to run when invoked as an alias or as an action button.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(CustomActionDefinition).

Parameters:

definition - a consumer that will call methods on CustomActionDefinition.Builder

Returns:

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

See Also:

• definition(CustomActionDefinition)

aliasName

CreateCustomActionRequest.Builder aliasName(String aliasName)

The name used to invoke this action in a chat channel. For example, @aws run my-alias.

Parameters:

aliasName - The name used to invoke this action in a chat channel. For example, @aws run my-alias.

Returns:

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

attachments

CreateCustomActionRequest.Builder attachments(Collection<CustomActionAttachment> attachments)

Defines when this custom action button should be attached to a notification.

Parameters:

attachments - Defines when this custom action button should be attached to a notification.

Returns:

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

attachments

CreateCustomActionRequest.Builder attachments(CustomActionAttachment... attachments)

Defines when this custom action button should be attached to a notification.

Parameters:

attachments - Defines when this custom action button should be attached to a notification.

Returns:

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

attachments

CreateCustomActionRequest.Builder attachments(Consumer<CustomActionAttachment.Builder>... attachments)

Defines when this custom action button should be attached to a notification.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachments(List<CustomActionAttachment>).

Parameters:

attachments - a consumer that will call methods on CustomActionAttachment.Builder

Returns:

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

See Also:

• attachments(java.util.Collection<CustomActionAttachment>)

tags

CreateCustomActionRequest.Builder tags(Collection<Tag> tags)

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Parameters:

tags - A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Returns:

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

tags

CreateCustomActionRequest.Builder tags(Tag... tags)

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Parameters:

tags - A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Returns:

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

tags

CreateCustomActionRequest.Builder tags(Consumer<Tag.Builder>... tags)

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

clientToken

CreateCustomActionRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the SDK.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the SDK.

Returns:

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

actionName

CreateCustomActionRequest.Builder actionName(String actionName)

The name of the custom action. This name is included in the Amazon Resource Name (ARN).

Parameters:

actionName - The name of the custom action. This name is included in the Amazon Resource Name (ARN).

Returns:

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

overrideConfiguration

CreateCustomActionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateCustomActionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.