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

Class ToolSpecification

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ToolSpecification

All Implemented Interfaces:

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

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

The specification for the tool. 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	ToolSpecification.Builder

Method Summary

Modifier and Type	Method	Description
static ToolSpecification.Builder	builder()
final String	description()	The description for the tool.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final ToolInputSchema	inputSchema()	The input schema for the tool in JSON format.
final String	name()	The name for the tool.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ToolSpecification.Builder>	serializableBuilderClass()
final Boolean	strict()	Flag to enable structured output enforcement on a tool usage response.
ToolSpecification.Builder	toBuilder()
final 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 Details

name

public final String name()

The name for the tool.

Returns:

The name for the tool.

description

public final String description()

The description for the tool.

Returns:

The description for the tool.

inputSchema

public final ToolInputSchema inputSchema()

The input schema for the tool in JSON format.

Returns:

The input schema for the tool in JSON format.

strict

public final Boolean strict()

Flag to enable structured output enforcement on a tool usage response.

Returns:

Flag to enable structured output enforcement on a tool usage response.

toBuilder

public ToolSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolSpecification.Builder,ToolSpecification>

builder

public static ToolSpecification.Builder builder()

serializableBuilderClass

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