Package software.amazon.awssdk.services.bedrockruntime.model

Class ToolReference

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

A reference to a tool in the tool configuration. Used with ToolAdditionBlock and ToolRemovalBlock to identify which tool to add or remove mid-conversation.

See Also:

  • Method Details

    • type

      public final String type()

      The type of tool reference.

      Returns:
      The type of tool reference.

    • name

      public final String name()

      The name of the tool. Must match the name of a tool declared in the top-level tool configuration.

      Returns:
      The name of the tool. Must match the name of a tool declared in the top-level tool configuration.

    • serverName

      public final String serverName()

      The name of the MCP server that provides the tool. Required when referencing an MCP tool.

      Returns:
      The name of the MCP server that provides the tool. Required when referencing an MCP tool.

    • toBuilder

      public ToolReference.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ToolReference.Builder,ToolReference>

    • builder

      public static ToolReference.Builder builder()

    • serializableBuilderClass

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

    • 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