Class ToolArguments

java.lang.Object
software.amazon.awssdk.services.bedrockagentcore.model.ToolArguments
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ToolArguments.Builder,ToolArguments>
@Generated("software.amazon.awssdk:codegen") public final class ToolArguments extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ToolArguments.Builder,ToolArguments>

The collection of arguments that specify the operation to perform and its parameters when invoking a tool in Amazon Bedrock. Different tools require different arguments, and this structure provides a flexible way to pass the appropriate arguments to each tool type.

See Also:

  • Method Details

    • code

      public final String code()

      The code to execute in a code interpreter session. This is the source code in the specified programming language that will be executed by the code interpreter.

      Returns:
      The code to execute in a code interpreter session. This is the source code in the specified programming language that will be executed by the code interpreter.

    • language

      public final ProgrammingLanguage language()

      The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution. Common values include 'python', 'javascript', and 'r'.

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

      Returns:
      The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution. Common values include 'python', 'javascript', and 'r'.
      See Also:

    • languageAsString

      public final String languageAsString()

      The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution. Common values include 'python', 'javascript', and 'r'.

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

      Returns:
      The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution. Common values include 'python', 'javascript', and 'r'.
      See Also:

    • clearContext

      public final Boolean clearContext()

      Whether to clear the context for the tool.

      Returns:
      Whether to clear the context for the tool.

    • command

      public final String command()

      The command to execute with the tool.

      Returns:
      The command to execute with the tool.

    • path

      public final String path()

      The path for the tool operation.

      Returns:
      The path for the tool operation.

    • hasPaths

      public final boolean hasPaths()
      For responses, this returns true if the service returned a value for the Paths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • paths

      public final List<String> paths()

      The paths for the tool operation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPaths() method.

      Returns:
      The paths for the tool operation.

    • hasContent

      public final boolean hasContent()
      For responses, this returns true if the service returned a value for the Content property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • content

      public final List<InputContentBlock> content()

      The content for the tool operation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContent() method.

      Returns:
      The content for the tool operation.

    • directoryPath

      public final String directoryPath()

      The directory path for the tool operation.

      Returns:
      The directory path for the tool operation.

    • taskId

      public final String taskId()

      The identifier of the task for the tool operation.

      Returns:
      The identifier of the task for the tool operation.

    • toBuilder

      public ToolArguments.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ToolArguments.Builder,ToolArguments>
      Returns:
      a builder for type T

    • builder

      public static ToolArguments.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.