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

Class ToolResultBlockStart

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ToolResultBlockStart

All Implemented Interfaces:

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

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

The start of a tool result block. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToolResultBlockStart.Builder

Method Summary

Modifier and Type	Method	Description
static ToolResultBlockStart.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ToolResultBlockStart.Builder>	serializableBuilderClass()
ToolResultStatus	status()	The status of the tool result block.
String	statusAsString()	The status of the tool result block.
ToolResultBlockStart.Builder	toBuilder()
String	toolUseId()	The ID of the tool that was used to generate this tool result block.
String	toString()	Returns a string representation of this object.
String	type()	The type for the tool that was used to generate this tool result block.

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 that was used to generate this tool result block.

Returns:

The ID of the tool that was used to generate this tool result block.

type

public final String type()

The type for the tool that was used to generate this tool result block.

Returns:

The type for the tool that was used to generate this tool result block.

status

public final ToolResultStatus status()

The status of the tool result block.

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 of the tool result block.

See Also:

ToolResultStatus

statusAsString

public final String statusAsString()

The status of the tool result block.

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 of the tool result block.

See Also:

ToolResultStatus

toBuilder

public ToolResultBlockStart.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolResultBlockStart.Builder,ToolResultBlockStart>

builder

public static ToolResultBlockStart.Builder builder()

serializableBuilderClass

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