Package software.amazon.awssdk.services.chatbot.model

Interface CustomAction.Builder

All Superinterfaces:

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

Enclosing class:

CustomAction

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

Method Summary

Modifier and Type	Method	Description
CustomAction.Builder	actionName(String actionName)	The name of the custom action that is included in the ARN.
CustomAction.Builder	aliasName(String aliasName)	The name used to invoke this action in the chat channel.
CustomAction.Builder	attachments(Collection<CustomActionAttachment> attachments)	Defines when this custom action button should be attached to a notification.
CustomAction.Builder	attachments(Consumer<CustomActionAttachment.Builder>... attachments)	Defines when this custom action button should be attached to a notification.
CustomAction.Builder	attachments(CustomActionAttachment... attachments)	Defines when this custom action button should be attached to a notification.
CustomAction.Builder	customActionArn(String customActionArn)	The fully defined Amazon Resource Name (ARN) of the custom action.
default CustomAction.Builder	definition(Consumer<CustomActionDefinition.Builder> definition)	The definition of the command to run when invoked an alias or as an action button.
CustomAction.Builder	definition(CustomActionDefinition definition)	The definition of the command to run when invoked an alias or as an action button.

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 Detail

customActionArn

CustomAction.Builder customActionArn(String customActionArn)

The fully defined Amazon Resource Name (ARN) of the custom action.

Parameters:

customActionArn - The fully defined Amazon Resource Name (ARN) of the custom action.

Returns:

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

definition

CustomAction.Builder definition(CustomActionDefinition definition)

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

Parameters:

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

Returns:

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

definition

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

The definition of the command to run when invoked 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

CustomAction.Builder aliasName(String aliasName)

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

Parameters:

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

Returns:

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

attachments

CustomAction.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

CustomAction.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

CustomAction.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).

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)

actionName

CustomAction.Builder actionName(String actionName)

The name of the custom action that is included in the ARN.

Parameters:

actionName - The name of the custom action that is included in the ARN.

Returns:

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