Package org.opensearch.client.opensearch.ml

Class Tool

java.lang.Object

org.opensearch.client.opensearch.ml.Tool

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Tool.Builder,Tool>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class Tool
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<Tool.Builder,Tool>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Tool>	_DESERIALIZER	Json deserializer for Tool

Method Summary

Modifier and Type	Method	Description
final ToolAttributes	attributes()	API name: attributes
static Tool.Builder	builder()
final String	description()	The tool description.
boolean	equals(Object o)
int	hashCode()
final String	name()	API name: name
static Tool	of(Function<Tool.Builder,ObjectBuilder<Tool>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupToolDeserializer(ObjectDeserializer<Tool.Builder> op)
Tool.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	type()	The tool type.
final String	version()	API name: version

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Tool> _DESERIALIZER

Json deserializer for Tool

Method Details

of

public static Tool of(Function<Tool.Builder,ObjectBuilder<Tool>> fn)

attributes

@Nullable
public final ToolAttributes attributes()

API name: attributes

description

@Nullable
public final String description()

The tool description.

API name: description

name

@Nullable
public final String name()

API name: name

type

@Nullable
public final String type()

The tool type.

API name: type

version

@Nullable
public final String version()

API name: version

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public Tool.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Tool.Builder,Tool>

Returns:

a new builder instance.

builder

@Nonnull
public static Tool.Builder builder()

setupToolDeserializer

protected static void setupToolDeserializer(ObjectDeserializer<Tool.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object