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

Class ToolResultContentBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ToolResultContentBlock

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ToolResultContentBlock.Builder,ToolResultContentBlock>

@Generated("software.amazon.awssdk:codegen")
public final class ToolResultContentBlock
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ToolResultContentBlock.Builder,ToolResultContentBlock>

The tool result content block.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToolResultContentBlock.Builder
static class	ToolResultContentBlock.Type

Method Summary

Modifier and Type	Method	Description
static ToolResultContentBlock.Builder	builder()
DocumentBlock	document()	A tool result that is a document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static ToolResultContentBlock	fromDocument(Consumer<DocumentBlock.Builder> document)	Create an instance of this class with document() initialized to the given value.
static ToolResultContentBlock	fromDocument(DocumentBlock document)	Create an instance of this class with document() initialized to the given value.
static ToolResultContentBlock	fromImage(Consumer<ImageBlock.Builder> image)	Create an instance of this class with image() initialized to the given value.
static ToolResultContentBlock	fromImage(ImageBlock image)	Create an instance of this class with image() initialized to the given value.
static ToolResultContentBlock	fromJson(Document json)	Create an instance of this class with json() initialized to the given value.
static ToolResultContentBlock	fromText(String text)	Create an instance of this class with text() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ImageBlock	image()	A tool result that is an image.
Document	json()	A tool result that is JSON format data.
List<SdkField<?>>	sdkFields()
static Class<? extends ToolResultContentBlock.Builder>	serializableBuilderClass()
String	text()	A tool result that is text.
ToolResultContentBlock.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ToolResultContentBlock.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

json

public final Document json()

A tool result that is JSON format data.

Returns:

A tool result that is JSON format data.

text

public final String text()

A tool result that is text.

Returns:

A tool result that is text.

image

public final ImageBlock image()

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

Returns:

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

document

public final DocumentBlock document()

A tool result that is a document.

Returns:

A tool result that is a document.

toBuilder

public ToolResultContentBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolResultContentBlock.Builder,ToolResultContentBlock>

builder

public static ToolResultContentBlock.Builder builder()

serializableBuilderClass

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

fromJson

public static ToolResultContentBlock fromJson(Document json)

Create an instance of this class with json() initialized to the given value.

A tool result that is JSON format data.

Parameters:

json - A tool result that is JSON format data.

fromText

public static ToolResultContentBlock fromText(String text)

Create an instance of this class with text() initialized to the given value.

A tool result that is text.

Parameters:

text - A tool result that is text.

fromImage

public static ToolResultContentBlock fromImage(ImageBlock image)

Create an instance of this class with image() initialized to the given value.

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

Parameters:

image - A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

fromImage

public static ToolResultContentBlock fromImage(Consumer<ImageBlock.Builder> image)

Create an instance of this class with image() initialized to the given value.

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

Parameters:

image - A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

fromDocument

public static ToolResultContentBlock fromDocument(DocumentBlock document)

Create an instance of this class with document() initialized to the given value.

A tool result that is a document.

Parameters:

document - A tool result that is a document.

fromDocument

public static ToolResultContentBlock fromDocument(Consumer<DocumentBlock.Builder> document)

Create an instance of this class with document() initialized to the given value.

A tool result that is a document.

Parameters:

document - A tool result that is a document.

type

public ToolResultContentBlock.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ToolResultContentBlock.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ToolResultContentBlock.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo