com.amazonaws.services.bedrockruntime.model

Class ToolSpecification

java.lang.Object

com.amazonaws.services.bedrockruntime.model.ToolSpecification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ToolSpecification
extends Object
implements Serializable, Cloneable, StructuredPojo

The specification for the tool.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ToolSpecification()

Method Summary

Modifier and Type	Method and Description
ToolSpecification	clone()
boolean	equals(Object obj)
String	getDescription() The description for the tool.
ToolInputSchema	getInputSchema() The input schema for the tool in JSON format.
String	getName() The name for the tool.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDescription(String description) The description for the tool.
void	setInputSchema(ToolInputSchema inputSchema) The input schema for the tool in JSON format.
void	setName(String name) The name for the tool.
String	toString() Returns a string representation of this object.
ToolSpecification	withDescription(String description) The description for the tool.
ToolSpecification	withInputSchema(ToolInputSchema inputSchema) The input schema for the tool in JSON format.
ToolSpecification	withName(String name) The name for the tool.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ToolSpecification

public ToolSpecification()

Method Detail

setName

public void setName(String name)

The name for the tool.

Parameters:

name - The name for the tool.

getName

public String getName()

The name for the tool.

Returns:

The name for the tool.

withName

public ToolSpecification withName(String name)

The name for the tool.

Parameters:

name - The name for the tool.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description for the tool.

Parameters:

description - The description for the tool.

getDescription

public String getDescription()

The description for the tool.

Returns:

The description for the tool.

withDescription

public ToolSpecification withDescription(String description)

The description for the tool.

Parameters:

description - The description for the tool.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInputSchema

public void setInputSchema(ToolInputSchema inputSchema)

The input schema for the tool in JSON format.

Parameters:

inputSchema - The input schema for the tool in JSON format.

getInputSchema

public ToolInputSchema getInputSchema()

The input schema for the tool in JSON format.

Returns:

The input schema for the tool in JSON format.

withInputSchema

public ToolSpecification withInputSchema(ToolInputSchema inputSchema)

The input schema for the tool in JSON format.

Parameters:

inputSchema - The input schema for the tool in JSON format.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ToolSpecification clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.