Package software.amazon.awssdk.services.bedrockruntime.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToolResultBlock.Builder

Method Summary

Modifier and Type	Method	Description
static ToolResultBlock.Builder	builder()
List<ToolResultContentBlock>	content()	The content for tool result content block.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContent()	For responses, this returns true if the service returned a value for the Content property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ToolResultBlock.Builder>	serializableBuilderClass()
ToolResultStatus	status()	The status for the tool result content block.
String	statusAsString()	The status for the tool result content block.
ToolResultBlock.Builder	toBuilder()
String	toolUseId()	The ID of the tool request that this is the result for.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ToolResultStatus

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:

ToolResultStatus

toBuilder

public ToolResultBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolResultBlock.Builder,ToolResultBlock>

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)

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