Interface InvokeAgentRuntimeRequest.Builder

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

  • Method Details

    • contentType

      InvokeAgentRuntimeRequest.Builder contentType(String contentType)

      The MIME type of the input data in the 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 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

      InvokeAgentRuntimeRequest.Builder accept(String accept)

      The desired MIME type for the response from the agent runtime. 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. 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.

    • mcpSessionId

      InvokeAgentRuntimeRequest.Builder mcpSessionId(String mcpSessionId)

      The identifier of the MCP session.

      Parameters:
      mcpSessionId - The identifier of the MCP session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeSessionId

      InvokeAgentRuntimeRequest.Builder runtimeSessionId(String runtimeSessionId)

      The identifier of the runtime session.

      Parameters:
      runtimeSessionId - The identifier of the runtime session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mcpProtocolVersion

      InvokeAgentRuntimeRequest.Builder mcpProtocolVersion(String mcpProtocolVersion)

      The version of the MCP protocol being used.

      Parameters:
      mcpProtocolVersion - The version of the MCP protocol being used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeUserId

      InvokeAgentRuntimeRequest.Builder runtimeUserId(String runtimeUserId)

      The identifier of the runtime user.

      Parameters:
      runtimeUserId - The identifier of the runtime user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • traceId

      InvokeAgentRuntimeRequest.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

      InvokeAgentRuntimeRequest.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

      InvokeAgentRuntimeRequest.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

      InvokeAgentRuntimeRequest.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

      InvokeAgentRuntimeRequest.Builder agentRuntimeArn(String agentRuntimeArn)

      The Amazon Web Services Resource Name (ARN) of the agent runtime to invoke. The ARN uniquely identifies the agent runtime resource in Amazon Bedrock.

      Parameters:
      agentRuntimeArn - The Amazon Web Services Resource Name (ARN) of the agent runtime to invoke. The ARN uniquely identifies the agent runtime resource in Amazon Bedrock.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualifier

      InvokeAgentRuntimeRequest.Builder qualifier(String qualifier)

      The qualifier to use for the agent runtime. This can be a version number or an alias name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.

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

    • payload

      InvokeAgentRuntimeRequest.Builder payload(SdkBytes payload)

      The input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user's request.

      Parameters:
      payload - The input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user's request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      InvokeAgentRuntimeRequest.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

      InvokeAgentRuntimeRequest.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.