Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface ActionGroupInvocationInput.Builder

All Superinterfaces:

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

Enclosing class:

ActionGroupInvocationInput

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

Method Summary

Modifier and Type	Method	Description
ActionGroupInvocationInput.Builder	actionGroupName(String actionGroupName)	The name of the action group.
ActionGroupInvocationInput.Builder	apiPath(String apiPath)	The path to the API to call, based off the action group.
ActionGroupInvocationInput.Builder	executionType(String executionType)	How fulfillment of the action is handled.
ActionGroupInvocationInput.Builder	executionType(ExecutionType executionType)	How fulfillment of the action is handled.
ActionGroupInvocationInput.Builder	function(String function)	The function in the action group to call.
ActionGroupInvocationInput.Builder	invocationId(String invocationId)	The unique identifier of the invocation.
ActionGroupInvocationInput.Builder	parameters(Collection<Parameter> parameters)	The parameters in the Lambda input event.
ActionGroupInvocationInput.Builder	parameters(Consumer<Parameter.Builder>... parameters)	The parameters in the Lambda input event.
ActionGroupInvocationInput.Builder	parameters(Parameter... parameters)	The parameters in the Lambda input event.
default ActionGroupInvocationInput.Builder	requestBody(Consumer<RequestBody.Builder> requestBody)	The parameters in the request body for the Lambda input event.
ActionGroupInvocationInput.Builder	requestBody(RequestBody requestBody)	The parameters in the request body for the Lambda input event.
ActionGroupInvocationInput.Builder	verb(String verb)	The API method being used, based off the action group.

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

actionGroupName

ActionGroupInvocationInput.Builder actionGroupName(String actionGroupName)

The name of the action group.

Parameters:

actionGroupName - The name of the action group.

Returns:

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

apiPath

ActionGroupInvocationInput.Builder apiPath(String apiPath)

The path to the API to call, based off the action group.

Parameters:

apiPath - The path to the API to call, based off the action group.

Returns:

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

executionType

ActionGroupInvocationInput.Builder executionType(String executionType)

How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

Parameters:

executionType - How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

Returns:

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

See Also:

ExecutionType, ExecutionType

executionType

ActionGroupInvocationInput.Builder executionType(ExecutionType executionType)

How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

Parameters:

executionType - How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

Returns:

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

See Also:

ExecutionType, ExecutionType

function

ActionGroupInvocationInput.Builder function(String function)

The function in the action group to call.

Parameters:

function - The function in the action group to call.

Returns:

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

invocationId

ActionGroupInvocationInput.Builder invocationId(String invocationId)

The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.

Parameters:

invocationId - The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.

Returns:

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

parameters

ActionGroupInvocationInput.Builder parameters(Collection<Parameter> parameters)

The parameters in the Lambda input event.

Parameters:

parameters - The parameters in the Lambda input event.

Returns:

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

parameters

ActionGroupInvocationInput.Builder parameters(Parameter... parameters)

The parameters in the Lambda input event.

Parameters:

parameters - The parameters in the Lambda input event.

Returns:

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

parameters

ActionGroupInvocationInput.Builder parameters(Consumer<Parameter.Builder>... parameters)

The parameters in the Lambda input event.

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

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

Parameters:

parameters - a consumer that will call methods on Parameter.Builder

Returns:

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

See Also:

#parameters(java.util.Collection)

requestBody

ActionGroupInvocationInput.Builder requestBody(RequestBody requestBody)

The parameters in the request body for the Lambda input event.

Parameters:

requestBody - The parameters in the request body for the Lambda input event.

Returns:

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

requestBody

default ActionGroupInvocationInput.Builder requestBody(Consumer<RequestBody.Builder> requestBody)

The parameters in the request body for the Lambda input event.

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

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

Parameters:

requestBody - a consumer that will call methods on RequestBody.Builder

Returns:

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

See Also:

requestBody(RequestBody)

verb

ActionGroupInvocationInput.Builder verb(String verb)

The API method being used, based off the action group.

Parameters:

verb - The API method being used, based off the action group.

Returns:

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