Class Tool

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

Information about a tool that you can use with the Converse API. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

See Also:

  • Method Details

    • toolSpec

      public final ToolSpecification toolSpec()

      The specfication for the tool.

      Returns:
      The specfication for the tool.

    • cachePoint

      public final CachePointBlock cachePoint()

      CachePoint to include in the tool configuration.

      Returns:
      CachePoint to include in the tool configuration.

    • toBuilder

      public Tool.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<Tool.Builder,Tool>
      Returns:
      a builder for type T

    • builder

      public static Tool.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Tool.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)

    • fromToolSpec

      public static Tool fromToolSpec(ToolSpecification toolSpec)
      Create an instance of this class with toolSpec() initialized to the given value.

      The specfication for the tool.

      Parameters:
      toolSpec - The specfication for the tool.

    • fromToolSpec

      public static Tool fromToolSpec(Consumer<ToolSpecification.Builder> toolSpec)
      Create an instance of this class with toolSpec() initialized to the given value.

      The specfication for the tool.

      Parameters:
      toolSpec - The specfication for the tool.

    • fromCachePoint

      public static Tool fromCachePoint(CachePointBlock cachePoint)
      Create an instance of this class with cachePoint() initialized to the given value.

      CachePoint to include in the tool configuration.

      Parameters:
      cachePoint - CachePoint to include in the tool configuration.

    • fromCachePoint

      public static Tool fromCachePoint(Consumer<CachePointBlock.Builder> cachePoint)
      Create an instance of this class with cachePoint() initialized to the given value.

      CachePoint to include in the tool configuration.

      Parameters:
      cachePoint - CachePoint to include in the tool configuration.

    • type

      public Tool.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Tool.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Tool.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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