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

Class SpecificToolChoice

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.SpecificToolChoice

All Implemented Interfaces:

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

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

The model must request a specific tool. For example, {"tool" : {"name" : "Your tool name"}}. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide

This field is only supported by Anthropic Claude 3 models.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpecificToolChoice.Builder

Method Summary

Modifier and Type	Method	Description
static SpecificToolChoice.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	name()	The name of the tool that the model must request.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends SpecificToolChoice.Builder>	serializableBuilderClass()
SpecificToolChoice.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 of the tool that the model must request.

Returns:

The name of the tool that the model must request.

toBuilder

public SpecificToolChoice.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SpecificToolChoice.Builder,SpecificToolChoice>

builder

public static SpecificToolChoice.Builder builder()

serializableBuilderClass

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