Class ToolSchema

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

A tool schema for a gateway target. This structure defines the schema for a tool that the target exposes through the Model Context Protocol.

See Also:

  • Method Details

    • s3

      public final S3Configuration s3()

      The Amazon S3 location of the tool schema. This location contains the schema definition file.

      Returns:
      The Amazon S3 location of the tool schema. This location contains the schema definition file.

    • hasInlinePayload

      public final boolean hasInlinePayload()
      For responses, this returns true if the service returned a value for the InlinePayload 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.

    • inlinePayload

      public final List<ToolDefinition> inlinePayload()

      The inline payload of the tool schema. This payload contains the schema definition directly in the request.

      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 hasInlinePayload() method.

      Returns:
      The inline payload of the tool schema. This payload contains the schema definition directly in the request.

    • toBuilder

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

    • builder

      public static ToolSchema.Builder builder()

    • serializableBuilderClass

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

    • fromS3

      public static ToolSchema fromS3(S3Configuration s3)
      Create an instance of this class with s3() initialized to the given value.

      The Amazon S3 location of the tool schema. This location contains the schema definition file.

      Parameters:
      s3 - The Amazon S3 location of the tool schema. This location contains the schema definition file.

    • fromS3

      public static ToolSchema fromS3(Consumer<S3Configuration.Builder> s3)
      Create an instance of this class with s3() initialized to the given value.

      The Amazon S3 location of the tool schema. This location contains the schema definition file.

      Parameters:
      s3 - The Amazon S3 location of the tool schema. This location contains the schema definition file.

    • fromInlinePayload

      public static ToolSchema fromInlinePayload(List<ToolDefinition> inlinePayload)
      Create an instance of this class with inlinePayload() initialized to the given value.

      The inline payload of the tool schema. This payload contains the schema definition directly in the request.

      Parameters:
      inlinePayload - The inline payload of the tool schema. This payload contains the schema definition directly in the request.

    • type

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