Package software.amazon.awscdk.services.bedrockagentcore

Class ToolDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.bedrockagentcore.ToolDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ToolDefinition>

Enclosing interface:

ToolDefinition

@Stability(Stable)
public static final class ToolDefinition.Builder
extends Object
implements software.amazon.jsii.Builder<ToolDefinition>

A builder for ToolDefinition

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ToolDefinition	build()	Builds the configured instance.
ToolDefinition.Builder	description(String description)	Sets the value of ToolDefinition.getDescription()
ToolDefinition.Builder	inputSchema(SchemaDefinition inputSchema)	Sets the value of ToolDefinition.getInputSchema()
ToolDefinition.Builder	name(String name)	Sets the value of ToolDefinition.getName()
ToolDefinition.Builder	outputSchema(SchemaDefinition outputSchema)	Sets the value of ToolDefinition.getOutputSchema()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

description

@Stability(Stable)
public ToolDefinition.Builder description(String description)

Sets the value of ToolDefinition.getDescription()

Parameters:

description - The description of the tool. This parameter is required. This description provides information about the purpose and usage of the tool.

Returns:

this

inputSchema

@Stability(Stable)
public ToolDefinition.Builder inputSchema(SchemaDefinition inputSchema)

Sets the value of ToolDefinition.getInputSchema()

Parameters:

inputSchema - The input schema for the tool. This parameter is required. This schema defines the structure of the input that the tool accepts.

Returns:

this

name

@Stability(Stable)
public ToolDefinition.Builder name(String name)

Sets the value of ToolDefinition.getName()

Parameters:

name - The name of the tool. This parameter is required. This name identifies the tool in the Model Context Protocol.

Returns:

this

outputSchema

@Stability(Stable)
public ToolDefinition.Builder outputSchema(SchemaDefinition outputSchema)

Sets the value of ToolDefinition.getOutputSchema()

Parameters:

outputSchema - The output schema for the tool. This schema defines the structure of the output that the tool produces.

Returns:

this

build

@Stability(Stable)
public ToolDefinition build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ToolDefinition>

Returns:

a new instance of ToolDefinition

Throws:

NullPointerException - if any required attribute was not provided