Class ParameterDetail

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

Contains details about a parameter in a function for an action group.

See Also:

  • Method Details

    • description

      public final String description()

      A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

      Returns:
      A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

    • required

      public final Boolean required()

      Whether the parameter is required for the agent to complete the function for action group invocation.

      Returns:
      Whether the parameter is required for the agent to complete the function for action group invocation.

    • type

      public final ParameterType type()

      The data type of the parameter.

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

      Returns:
      The data type of the parameter.
      See Also:

    • typeAsString

      public final String typeAsString()

      The data type of the parameter.

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

      Returns:
      The data type of the parameter.
      See Also:

    • toBuilder

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

    • builder

      public static ParameterDetail.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.