Package software.amazon.awssdk.services.bedrockagentcore.model

Class InvokeCodeInterpreterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.InvokeCodeInterpreterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeCodeInterpreterRequest.Builder,InvokeCodeInterpreterRequest>
@Generated("software.amazon.awssdk:codegen") public final class InvokeCodeInterpreterRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<InvokeCodeInterpreterRequest.Builder,InvokeCodeInterpreterRequest>

  • Method Details

    • codeInterpreterIdentifier

      public final 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.

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

    • sessionId

      public final 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.

      Returns:
      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.

    • traceId

      public final String traceId()

      The trace identifier for request tracking.

      Returns:
      The trace identifier for request tracking.

    • traceParent

      public final String traceParent()

      The parent trace information for distributed tracing.

      Returns:
      The parent trace information for distributed tracing.

    • name

      public final ToolName name()

      The name of the code interpreter to invoke.

      If the service returns an enum value that is not available in the current SDK version, name will return ToolName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The name of the code interpreter to invoke.
      See Also:

    • nameAsString

      public final String nameAsString()

      The name of the code interpreter to invoke.

      If the service returns an enum value that is not available in the current SDK version, name will return ToolName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The name of the code interpreter to invoke.
      See Also:

    • arguments

      public final 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.

      Returns:
      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.

    • toBuilder

      public InvokeCodeInterpreterRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<InvokeCodeInterpreterRequest.Builder,InvokeCodeInterpreterRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest

    • builder

      public static InvokeCodeInterpreterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InvokeCodeInterpreterRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo