Interface InvokeAgentRuntimeCommandRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreRequest.Builder, Buildable, CopyableBuilder<InvokeAgentRuntimeCommandRequest.Builder,InvokeAgentRuntimeCommandRequest>, SdkBuilder<InvokeAgentRuntimeCommandRequest.Builder,InvokeAgentRuntimeCommandRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
InvokeAgentRuntimeCommandRequest
@Mutable @NotThreadSafe public static interface InvokeAgentRuntimeCommandRequest.Builder extends BedrockAgentCoreRequest.Builder, SdkPojo, CopyableBuilder<InvokeAgentRuntimeCommandRequest.Builder,InvokeAgentRuntimeCommandRequest>

  • Method Details

    • contentType

      InvokeAgentRuntimeCommandRequest.Builder contentType(String contentType)

      The MIME type of the input data in the request payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.

      Parameters:
      contentType - The MIME type of the input data in the request payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accept

      InvokeAgentRuntimeCommandRequest.Builder accept(String accept)

      The desired MIME type for the response from the agent runtime command. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.

      Parameters:
      accept - The desired MIME type for the response from the agent runtime command. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeSessionId

      InvokeAgentRuntimeCommandRequest.Builder runtimeSessionId(String runtimeSessionId)

      The unique identifier of the runtime session in which to execute the command. This session ID is used to maintain state and context across multiple command invocations.

      Parameters:
      runtimeSessionId - The unique identifier of the runtime session in which to execute the command. This session ID is used to maintain state and context across multiple command invocations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • traceId

      InvokeAgentRuntimeCommandRequest.Builder traceId(String traceId)

      The trace identifier for request tracking.

      Parameters:
      traceId - The trace identifier for request tracking.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • traceParent

      InvokeAgentRuntimeCommandRequest.Builder traceParent(String traceParent)

      The parent trace information for distributed tracing.

      Parameters:
      traceParent - The parent trace information for distributed tracing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • traceState

      InvokeAgentRuntimeCommandRequest.Builder traceState(String traceState)

      The trace state information for distributed tracing.

      Parameters:
      traceState - The trace state information for distributed tracing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baggage

      InvokeAgentRuntimeCommandRequest.Builder baggage(String baggage)

      Additional context information for distributed tracing.

      Parameters:
      baggage - Additional context information for distributed tracing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentRuntimeArn

      InvokeAgentRuntimeCommandRequest.Builder agentRuntimeArn(String agentRuntimeArn)

      The Amazon Resource Name (ARN) of the agent runtime on which to execute the command. This identifies the specific agent runtime environment where the command will run.

      Parameters:
      agentRuntimeArn - The Amazon Resource Name (ARN) of the agent runtime on which to execute the command. This identifies the specific agent runtime environment where the command will run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualifier

      InvokeAgentRuntimeCommandRequest.Builder qualifier(String qualifier)

      The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.

      Parameters:
      qualifier - The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountId

      InvokeAgentRuntimeCommandRequest.Builder accountId(String accountId)

      The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for agentRuntimeArn.

      Parameters:
      accountId - The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for agentRuntimeArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      InvokeAgentRuntimeCommandRequest.Builder body(InvokeAgentRuntimeCommandRequestBody body)

      The request body containing the command to execute and optional configuration parameters such as timeout settings.

      Parameters:
      body - The request body containing the command to execute and optional configuration parameters such as timeout settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      default InvokeAgentRuntimeCommandRequest.Builder body(Consumer<InvokeAgentRuntimeCommandRequestBody.Builder> body)

      The request body containing the command to execute and optional configuration parameters such as timeout settings.

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

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

      Parameters:
      body - a consumer that will call methods on InvokeAgentRuntimeCommandRequestBody.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      InvokeAgentRuntimeCommandRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      InvokeAgentRuntimeCommandRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.