Package org.opensearch.client.opensearch.ml

Class ExecuteAgentRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ml.ExecuteAgentRequest

All Implemented Interfaces:

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

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

Execute an agent.

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<ExecuteAgentRequest>	_DESERIALIZER	Json deserializer for ExecuteAgentRequest
static final Endpoint<ExecuteAgentRequest,ExecuteAgentResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.execute_agent".

Method Summary

Modifier and Type	Method	Description
final String	agentId()	Required - API name: agent_id
static ExecuteAgentRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static ExecuteAgentRequest	of(Function<ExecuteAgentRequest.Builder,ObjectBuilder<ExecuteAgentRequest>> fn)
final Map<String,JsonData>	parameters()	Required - API name: parameters
final Boolean	parametersVerbose()	Whether to provide verbose output.
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	setupExecuteAgentRequestDeserializer(ObjectDeserializer<ExecuteAgentRequest.Builder> op)
ExecuteAgentRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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 Details

_DESERIALIZER

public static final JsonpDeserializer<ExecuteAgentRequest> _DESERIALIZER

Json deserializer for ExecuteAgentRequest

_ENDPOINT

public static final Endpoint<ExecuteAgentRequest,ExecuteAgentResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.execute_agent".

Method Details

of

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

agentId

@Nonnull
public final String agentId()

Required - API name: agent_id

parameters

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

Required - API name: parameters

parametersVerbose

@Nullable
public final Boolean parametersVerbose()

Whether to provide verbose output.

API name: parameters.verbose

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

Returns:

a new builder instance.

builder

@Nonnull
public static ExecuteAgentRequest.Builder builder()

setupExecuteAgentRequestDeserializer

protected static void setupExecuteAgentRequestDeserializer(ObjectDeserializer<ExecuteAgentRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object