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

Class Tool

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.Tool

All Implemented Interfaces:

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

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

Information about a tool that you can use with the Converse API. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Tool.Builder	builder()
CachePointBlock	cachePoint()	CachePoint to include in the tool configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static Tool	fromCachePoint(Consumer<CachePointBlock.Builder> cachePoint)	Create an instance of this class with cachePoint() initialized to the given value.
static Tool	fromCachePoint(CachePointBlock cachePoint)	Create an instance of this class with cachePoint() initialized to the given value.
static Tool	fromToolSpec(Consumer<ToolSpecification.Builder> toolSpec)	Create an instance of this class with toolSpec() initialized to the given value.
static Tool	fromToolSpec(ToolSpecification toolSpec)	Create an instance of this class with toolSpec() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Tool.Builder>	serializableBuilderClass()
Tool.Builder	toBuilder()
ToolSpecification	toolSpec()	The specfication for the tool.
String	toString()	Returns a string representation of this object.
Tool.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

toolSpec

public final ToolSpecification toolSpec()

The specfication for the tool.

Returns:

The specfication for the tool.

cachePoint

public final CachePointBlock cachePoint()

CachePoint to include in the tool configuration.

Returns:

CachePoint to include in the tool configuration.

toBuilder

public Tool.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Tool.Builder,Tool>

builder

public static Tool.Builder builder()

serializableBuilderClass

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

fromToolSpec

public static Tool fromToolSpec(ToolSpecification toolSpec)

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

The specfication for the tool.

Parameters:

toolSpec - The specfication for the tool.

fromToolSpec

public static Tool fromToolSpec(Consumer<ToolSpecification.Builder> toolSpec)

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

The specfication for the tool.

Parameters:

toolSpec - The specfication for the tool.

fromCachePoint

public static Tool fromCachePoint(CachePointBlock cachePoint)

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

CachePoint to include in the tool configuration.

Parameters:

cachePoint - CachePoint to include in the tool configuration.

fromCachePoint

public static Tool fromCachePoint(Consumer<CachePointBlock.Builder> cachePoint)

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

CachePoint to include in the tool configuration.

Parameters:

cachePoint - CachePoint to include in the tool configuration.

type

public Tool.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 Tool.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 Tool.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo