Class FunctionSchema

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

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

This data type is used in the following API operations:

See Also:

  • Method Details

    • hasFunctions

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

    • functions

      public final List<Function> functions()

      A list of functions that each define an action in the action group.

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

      Returns:
      A list of functions that each define an action in the action group.

    • toBuilder

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

    • builder

      public static FunctionSchema.Builder builder()

    • serializableBuilderClass

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

    • fromFunctions

      public static FunctionSchema fromFunctions(List<Function> functions)
      Create an instance of this class with functions() initialized to the given value.

      A list of functions that each define an action in the action group.

      Parameters:
      functions - A list of functions that each define an action in the action group.

    • type

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