Class ToolResultStructuredContent

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

Contains structured content from a tool result.

See Also:

  • Method Details

    • taskId

      public final String taskId()

      The identifier of the task that produced the result.

      Returns:
      The identifier of the task that produced the result.

    • taskStatus

      public final TaskStatus taskStatus()

      The status of the task that produced the result.

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

      Returns:
      The status of the task that produced the result.
      See Also:

    • taskStatusAsString

      public final String taskStatusAsString()

      The status of the task that produced the result.

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

      Returns:
      The status of the task that produced the result.
      See Also:

    • stdout

      public final String stdout()

      The standard output from the tool execution.

      Returns:
      The standard output from the tool execution.

    • stderr

      public final String stderr()

      The standard error output from the tool execution.

      Returns:
      The standard error output from the tool execution.

    • exitCode

      public final Integer exitCode()

      The exit code from the tool execution.

      Returns:
      The exit code from the tool execution.

    • executionTime

      public final Double executionTime()

      The execution time of the tool operation in milliseconds.

      Returns:
      The execution time of the tool operation in milliseconds.

    • toBuilder

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

    • builder

      public static ToolResultStructuredContent.Builder builder()

    • serializableBuilderClass

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