Interface ActionExecutionEvent.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ActionExecutionEvent.Builder,ActionExecutionEvent>,SdkBuilder<ActionExecutionEvent.Builder,ActionExecutionEvent>,SdkPojo
- All Known Subinterfaces:
DefaultActionExecutionEvent.Builder
- All Known Implementing Classes:
ActionExecutionEvent.BuilderImpl
- Enclosing class:
- ActionExecutionEvent
public static interface ActionExecutionEvent.Builder extends SdkPojo, CopyableBuilder<ActionExecutionEvent.Builder,ActionExecutionEvent>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ActionExecutionEvent.Builderpayload(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.ActionExecutionEvent.BuilderpayloadFieldNameSeparator(String payloadFieldNameSeparator)A string used to retain information about the hierarchical contexts within a action execution event payload.ActionExecutionEvent.BuilderpluginId(String pluginId)The identifier of the plugin for which the action is being requested.-
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, sdkFields
-
-
-
-
Method Detail
-
pluginId
ActionExecutionEvent.Builder pluginId(String pluginId)
The identifier of the plugin for which the action is being requested.
- Parameters:
pluginId- The identifier of the plugin for which the action is being requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
payload
ActionExecutionEvent.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
ActionExecutionEvent.Builder payloadFieldNameSeparator(String payloadFieldNameSeparator)
A string used to retain information about the hierarchical contexts within a action execution event payload.
- Parameters:
payloadFieldNameSeparator- A string used to retain information about the hierarchical contexts within a action execution event payload.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-