Class ToolResultBlock

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

A tool result block that contains the results for a tool request that the model previously made.

See Also:

  • Method Details

    • toolUseId

      public final String toolUseId()

      The ID of the tool request that this is the result for.

      Returns:
      The ID of the tool request that this is the result for.

    • hasContent

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

    • content

      public final List<ToolResultContentBlock> content()

      The content for tool result content block.

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

      Returns:
      The content for tool result content block.

    • status

      public final ToolResultStatus status()

      The status for the tool result content block.

      This field is only supported Anthropic Claude 3 models.

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

      Returns:
      The status for the tool result content block.

      This field is only supported Anthropic Claude 3 models.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status for the tool result content block.

      This field is only supported Anthropic Claude 3 models.

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

      Returns:
      The status for the tool result content block.

      This field is only supported Anthropic Claude 3 models.

      See Also:

    • toBuilder

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

    • builder

      public static ToolResultBlock.Builder builder()

    • serializableBuilderClass

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