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

Class ToolInputSchema

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ToolInputSchema

All Implemented Interfaces:

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

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

The schema for the tool. The top level schema type must be object. 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	ToolInputSchema.Builder
static enum	ToolInputSchema.Type

Method Summary

Modifier and Type	Method	Description
static ToolInputSchema.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
static ToolInputSchema	fromJson(Document json)	Create an instance of this class with json() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Document	json()	The JSON schema for the tool.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ToolInputSchema.Builder>	serializableBuilderClass()
ToolInputSchema.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
ToolInputSchema.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 Details

json

public final Document json()

The JSON schema for the tool. For more information, see JSON Schema Reference.

Returns:

The JSON schema for the tool. For more information, see JSON Schema Reference.

toBuilder

public ToolInputSchema.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolInputSchema.Builder,ToolInputSchema>

builder

public static ToolInputSchema.Builder builder()

serializableBuilderClass

public static Class<? extends ToolInputSchema.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 ToolInputSchema fromJson(Document json)

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

The JSON schema for the tool. For more information, see JSON Schema Reference.

Parameters:

json - The JSON schema for the tool. For more information, see JSON Schema Reference.

type

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