Interface ActionExecution.Builder

All Superinterfaces:

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

Enclosing class:

ActionExecution

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

Method Summary

Modifier and Type	Method	Description
ActionExecution.Builder	payload(Map<String,ActionExecutionPayloadField> payload)	A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
ActionExecution.Builder	payloadFieldNameSeparator(String payloadFieldNameSeparator)	A string used to retain information about the hierarchical contexts within an action execution event payload.
ActionExecution.Builder	pluginId(String pluginId)	The identifier of the plugin the action is attached to.

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

pluginId

ActionExecution.Builder pluginId(String pluginId)

The identifier of the plugin the action is attached to.

Parameters:

pluginId - The identifier of the plugin the action is attached to.

Returns:

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

payload

ActionExecution.Builder payload(Map<String,ActionExecutionPayloadField> payload)

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

Parameters:

payload - A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

Returns:

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

payloadFieldNameSeparator

ActionExecution.Builder payloadFieldNameSeparator(String payloadFieldNameSeparator)

A string used to retain information about the hierarchical contexts within an action execution event payload.

Parameters:

payloadFieldNameSeparator - A string used to retain information about the hierarchical contexts within an action execution event payload.

Returns:

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