Interface InvokeCodeInterpreterRequest.Builder

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

  • Method Details

    • codeInterpreterIdentifier

      InvokeCodeInterpreterRequest.Builder codeInterpreterIdentifier(String codeInterpreterIdentifier)

      The unique identifier of the code interpreter associated with the session. This must match the identifier used when creating the session with StartCodeInterpreterSession.

      Parameters:
      codeInterpreterIdentifier - The unique identifier of the code interpreter associated with the session. This must match the identifier used when creating the session with StartCodeInterpreterSession.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      InvokeCodeInterpreterRequest.Builder sessionId(String sessionId)

      The unique identifier of the code interpreter session to use. This must be an active session created with StartCodeInterpreterSession. If the session has expired or been stopped, the request will fail.

      Parameters:
      sessionId - The unique identifier of the code interpreter session to use. This must be an active session created with StartCodeInterpreterSession. If the session has expired or been stopped, the request will fail.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      InvokeCodeInterpreterRequest.Builder name(String name)

      The name of the code interpreter to invoke.

      Parameters:
      name - The name of the code interpreter to invoke.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      InvokeCodeInterpreterRequest.Builder name(ToolName name)

      The name of the code interpreter to invoke.

      Parameters:
      name - The name of the code interpreter to invoke.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • arguments

      InvokeCodeInterpreterRequest.Builder arguments(ToolArguments arguments)

      The arguments for the code interpreter. This includes the code to execute and any additional parameters such as the programming language, whether to clear the execution context, and other execution options. The structure of this parameter depends on the specific code interpreter being used.

      Parameters:
      arguments - The arguments for the code interpreter. This includes the code to execute and any additional parameters such as the programming language, whether to clear the execution context, and other execution options. The structure of this parameter depends on the specific code interpreter being used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arguments

      default InvokeCodeInterpreterRequest.Builder arguments(Consumer<ToolArguments.Builder> arguments)

      The arguments for the code interpreter. This includes the code to execute and any additional parameters such as the programming language, whether to clear the execution context, and other execution options. The structure of this parameter depends on the specific code interpreter being used.

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

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

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

    • overrideConfiguration

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

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