Package org.opensearch.client.opensearch.ml

Class ToolItems

java.lang.Object

org.opensearch.client.opensearch.ml.ToolItems

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final ToolAttributes	attributes()	API name: attributes
static ToolItems.Builder	builder()
final String	description()	API name: description
boolean	equals(Object o)
int	hashCode()
final Boolean	includeOutputInAgentResponse()	API name: include_output_in_agent_response
final Map<String,JsonData>	metadata()
final String	name()	API name: name
static ToolItems	of(Function<ToolItems.Builder,ObjectBuilder<ToolItems>> fn)
final Map<String,JsonData>	parameters()	API name: parameters
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	setupToolItemsDeserializer(ObjectDeserializer<ToolItems.Builder> op)
ToolItems.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	type()	API name: type

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<ToolItems> _DESERIALIZER

Json deserializer for ToolItems

Method Details

of

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

attributes

@Nullable
public final ToolAttributes attributes()

API name: attributes

description

@Nullable
public final String description()

API name: description

includeOutputInAgentResponse

@Nullable
public final Boolean includeOutputInAgentResponse()

API name: include_output_in_agent_response

metadata

@Nonnull
public final Map<String,JsonData> metadata()

name

@Nullable
public final String name()

API name: name

parameters

@Nonnull
public final Map<String,JsonData> parameters()

API name: parameters

type

@Nullable
public final String type()

API name: type

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 ToolItems.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<ToolItems.Builder,ToolItems>

Returns:

a new builder instance.

builder

@Nonnull
public static ToolItems.Builder builder()

setupToolItemsDeserializer

protected static void setupToolItemsDeserializer(ObjectDeserializer<ToolItems.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object