java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.ml.RegisterAgentsRequest

All Implemented Interfaces:: JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RegisterAgentsRequest.Builder,RegisterAgentsRequest>

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

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`appType()`	API name: `app_type`
`static RegisterAgentsRequest.Builder`	`builder()`
`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)`
`RegisterAgentsRequest.Builder`	`toBuilder()`	Create a new builder `ToCopyableBuilder` that is initialised with the current state of this object.
`java.util.List<ToolItems>`	`tools()`	API name: `tools`
`java.lang.String`	`type()`	Required - API name: `type`

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
applyQueryParameters, errorTrace, human

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

toBuilder
```
@Nonnull
public RegisterAgentsRequest.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<RegisterAgentsRequest.Builder,RegisterAgentsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static RegisterAgentsRequest.Builder builder()

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

Class RegisterAgentsRequest

Nested Class Summary

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