Package software.amazon.awssdk.services.bedrockagentcore.model

Class ToolDescriptionRecommendationResult

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

The result of a tool description recommendation, containing optimized descriptions.

See Also:

  • Method Details

    • hasTools

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

    • tools

      public final List<ToolDescriptionOutput> tools()

      The list of tools with their recommended descriptions.

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

      Returns:
      The list of tools with their recommended descriptions.

    • configurationBundle

      public final RecommendationResultConfigurationBundle configurationBundle()

      The configuration bundle containing the recommended tool descriptions, if the input was sourced from a configuration bundle.

      Returns:
      The configuration bundle containing the recommended tool descriptions, if the input was sourced from a configuration bundle.

    • errorCode

      public final String errorCode()

      The error code if the recommendation failed.

      Returns:
      The error code if the recommendation failed.

    • errorMessage

      public final String errorMessage()

      The error message if the recommendation failed.

      Returns:
      The error message if the recommendation failed.

    • toBuilder

      public ToolDescriptionRecommendationResult.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ToolDescriptionRecommendationResult.Builder,ToolDescriptionRecommendationResult>

    • builder

      public static ToolDescriptionRecommendationResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ToolDescriptionRecommendationResult.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo