Class Function

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

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

This data type is used in the following API operations:

See Also:

  • Method Details

    • description

      public final String description()

      A description of the function and its purpose.

      Returns:
      A description of the function and its purpose.

    • name

      public final String name()

      A name for the function.

      Returns:
      A name for the function.

    • hasParameters

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

    • parameters

      public final Map<String,ParameterDetail> parameters()

      The parameters that the agent elicits from the user to fulfill the function.

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

      Returns:
      The parameters that the agent elicits from the user to fulfill the function.

    • requireConfirmation

      public final RequireConfirmation requireConfirmation()

      Contains information if user confirmation is required to invoke the function.

      If the service returns an enum value that is not available in the current SDK version, requireConfirmation will return RequireConfirmation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requireConfirmationAsString().

      Returns:
      Contains information if user confirmation is required to invoke the function.
      See Also:

    • requireConfirmationAsString

      public final String requireConfirmationAsString()

      Contains information if user confirmation is required to invoke the function.

      If the service returns an enum value that is not available in the current SDK version, requireConfirmation will return RequireConfirmation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requireConfirmationAsString().

      Returns:
      Contains information if user confirmation is required to invoke the function.
      See Also:

    • toBuilder

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

    • builder

      public static Function.Builder builder()

    • serializableBuilderClass

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

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