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

Interface ApiInvocationInput.Builder

All Superinterfaces:

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

Enclosing class:

ApiInvocationInput

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

Method Summary

Modifier and Type	Method	Description
ApiInvocationInput.Builder	actionGroup(String actionGroup)	The action group that the API operation belongs to.
ApiInvocationInput.Builder	actionInvocationType(String actionInvocationType)	Contains information about the API operation to invoke.
ApiInvocationInput.Builder	actionInvocationType(ActionInvocationType actionInvocationType)	Contains information about the API operation to invoke.
ApiInvocationInput.Builder	agentId(String agentId)	The agent's ID.
ApiInvocationInput.Builder	apiPath(String apiPath)	The path to the API operation.
ApiInvocationInput.Builder	collaboratorName(String collaboratorName)	The agent collaborator's name.
ApiInvocationInput.Builder	httpMethod(String httpMethod)	The HTTP method of the API operation.
ApiInvocationInput.Builder	parameters(Collection<ApiParameter> parameters)	The parameters to provide for the API request, as the agent elicited from the user.
ApiInvocationInput.Builder	parameters(Consumer<ApiParameter.Builder>... parameters)	The parameters to provide for the API request, as the agent elicited from the user.
ApiInvocationInput.Builder	parameters(ApiParameter... parameters)	The parameters to provide for the API request, as the agent elicited from the user.
default ApiInvocationInput.Builder	requestBody(Consumer<ApiRequestBody.Builder> requestBody)	The request body to provide for the API request, as the agent elicited from the user.
ApiInvocationInput.Builder	requestBody(ApiRequestBody requestBody)	The request body to provide for the API request, as the agent elicited from the user.

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

actionGroup

ApiInvocationInput.Builder actionGroup(String actionGroup)

The action group that the API operation belongs to.

Parameters:

actionGroup - The action group that the API operation belongs to.

Returns:

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

actionInvocationType

ApiInvocationInput.Builder actionInvocationType(String actionInvocationType)

Contains information about the API operation to invoke.

Parameters:

actionInvocationType - Contains information about the API operation to invoke.

Returns:

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

See Also:

ActionInvocationType, ActionInvocationType

actionInvocationType

ApiInvocationInput.Builder actionInvocationType(ActionInvocationType actionInvocationType)

Contains information about the API operation to invoke.

Parameters:

actionInvocationType - Contains information about the API operation to invoke.

Returns:

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

See Also:

ActionInvocationType, ActionInvocationType

agentId

ApiInvocationInput.Builder agentId(String agentId)

The agent's ID.

Parameters:

agentId - The agent's ID.

Returns:

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

apiPath

ApiInvocationInput.Builder apiPath(String apiPath)

The path to the API operation.

Parameters:

apiPath - The path to the API operation.

Returns:

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

collaboratorName

ApiInvocationInput.Builder collaboratorName(String collaboratorName)

The agent collaborator's name.

Parameters:

collaboratorName - The agent collaborator's name.

Returns:

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

httpMethod

ApiInvocationInput.Builder httpMethod(String httpMethod)

The HTTP method of the API operation.

Parameters:

httpMethod - The HTTP method of the API operation.

Returns:

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

parameters

ApiInvocationInput.Builder parameters(Collection<ApiParameter> parameters)

The parameters to provide for the API request, as the agent elicited from the user.

Parameters:

parameters - The parameters to provide for the API request, as the agent elicited from the user.

Returns:

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

parameters

ApiInvocationInput.Builder parameters(ApiParameter... parameters)

The parameters to provide for the API request, as the agent elicited from the user.

Parameters:

parameters - The parameters to provide for the API request, as the agent elicited from the user.

Returns:

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

parameters

ApiInvocationInput.Builder parameters(Consumer<ApiParameter.Builder>... parameters)

The parameters to provide for the API request, as the agent elicited from the user.

This is a convenience method that creates an instance of the ApiParameter.Builder avoiding the need to create one manually via ApiParameter.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 ApiParameter.Builder

Returns:

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

See Also:

#parameters(java.util.Collection)

requestBody

ApiInvocationInput.Builder requestBody(ApiRequestBody requestBody)

The request body to provide for the API request, as the agent elicited from the user.

Parameters:

requestBody - The request body to provide for the API request, as the agent elicited from the user.

Returns:

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

requestBody

default ApiInvocationInput.Builder requestBody(Consumer<ApiRequestBody.Builder> requestBody)

The request body to provide for the API request, as the agent elicited from the user.

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

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

Parameters:

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

Returns:

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

See Also:

requestBody(ApiRequestBody)