Package org.opensearch.client.opensearch.ml

Class RegisterAgentsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.RegisterAgentsRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RegisterAgentsRequest
extends RequestBase
implements PlainJsonSerializable

Register an agent.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RegisterAgentsRequest>	_DESERIALIZER	Json deserializer for RegisterAgentsRequest
static Endpoint<RegisterAgentsRequest,RegisterAgentsResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.register_agents".

Method Summary

Modifier and Type	Method	Description
java.lang.String	appType()	API name: app_type
java.lang.String	description()	API name: description
boolean	equals(java.lang.Object o)
int	hashCode()
LLM	llm()	API name: llm
Memory	memory()	API name: memory
java.lang.String	name()	Required - API name: name
static RegisterAgentsRequest	of(java.util.function.Function<RegisterAgentsRequest.Builder,ObjectBuilder<RegisterAgentsRequest>> fn)
java.util.Map<java.lang.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	setupRegisterAgentsRequestDeserializer(ObjectDeserializer<RegisterAgentsRequest.Builder> op)
java.util.List<ToolItems>	tools()	API name: tools
java.lang.String	type()	Required - 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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<RegisterAgentsRequest> _DESERIALIZER

Json deserializer for RegisterAgentsRequest

_ENDPOINT

public static final Endpoint<RegisterAgentsRequest,RegisterAgentsResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.register_agents".

Method Detail

of

public static RegisterAgentsRequest of(java.util.function.Function<RegisterAgentsRequest.Builder,ObjectBuilder<RegisterAgentsRequest>> fn)

appType

@Nullable
public final java.lang.String appType()

API name: app_type

description

@Nullable
public final java.lang.String description()

API name: description

llm

@Nullable
public final LLM llm()

API name: llm

memory

@Nullable
public final Memory memory()

API name: memory

name

@Nonnull
public final java.lang.String name()

Required - API name: name

parameters

@Nonnull
public final java.util.Map<java.lang.String,JsonData> parameters()

API name: parameters

tools

@Nonnull
public final java.util.List<ToolItems> tools()

API name: tools

type

@Nonnull
public final java.lang.String type()

Required - 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)

setupRegisterAgentsRequestDeserializer

protected static void setupRegisterAgentsRequestDeserializer(ObjectDeserializer<RegisterAgentsRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object