Class ToolInputSchema

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

The schema for the tool. The top level schema type must be object.

See Also:

  • Method Details

    • json

      public final Document json()

      The JSON schema for the tool. For more information, see JSON Schema Reference.

      Returns:
      The JSON schema for the tool. For more information, see JSON Schema Reference.

    • toBuilder

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

    • builder

      public static ToolInputSchema.Builder builder()

    • serializableBuilderClass

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

    • fromJson

      public static ToolInputSchema fromJson(Document json)
      Create an instance of this class with json() initialized to the given value.

      The JSON schema for the tool. For more information, see JSON Schema Reference.

      Parameters:
      json - The JSON schema for the tool. For more information, see JSON Schema Reference.

    • type

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