Package org.opensearch.client.opensearch.ml

Class ExecuteAgentRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ExecuteAgentRequest.Builder>

org.opensearch.client.opensearch.ml.ExecuteAgentRequest.Builder

All Implemented Interfaces:

CopyableBuilder<ExecuteAgentRequest.Builder,ExecuteAgentRequest>, MutableBuilder<ExecuteAgentRequest.Builder,ExecuteAgentRequest>, ObjectBuilder<ExecuteAgentRequest>

Enclosing class:

ExecuteAgentRequest

public static class ExecuteAgentRequest.Builder
extends RequestBase.AbstractBuilder<ExecuteAgentRequest.Builder>
implements CopyableBuilder<ExecuteAgentRequest.Builder,ExecuteAgentRequest>

Builder for ExecuteAgentRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ExecuteAgentRequest.Builder	agentId(String value)	Required - API name: agent_id
ExecuteAgentRequest	build()	Builds a ExecuteAgentRequest.
ExecuteAgentRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ExecuteAgentRequest.Builder	parameters(String key, JsonData value)	Required - API name: parameters
final ExecuteAgentRequest.Builder	parameters(Map<String,JsonData> map)	Required - API name: parameters
final ExecuteAgentRequest.Builder	parametersVerbose(Boolean value)	Whether to provide verbose output.
protected ExecuteAgentRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ExecuteAgentRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ExecuteAgentRequest.Builder,ExecuteAgentRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ExecuteAgentRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExecuteAgentRequest.Builder>

agentId

@Nonnull
public final ExecuteAgentRequest.Builder agentId(String value)

Required - API name: agent_id

parameters

@Nonnull
public final ExecuteAgentRequest.Builder parameters(Map<String,JsonData> map)

Required - API name: parameters

Adds all elements of map to parameters.

parameters

@Nonnull
public final ExecuteAgentRequest.Builder parameters(String key,
 JsonData value)

Required - API name: parameters

Adds an entry to parameters.

parametersVerbose

@Nonnull
public final ExecuteAgentRequest.Builder parametersVerbose(@Nullable
 Boolean value)

Whether to provide verbose output.

API name: parameters.verbose

build

@Nonnull
public ExecuteAgentRequest build()

Builds a ExecuteAgentRequest.

Specified by:

build in interface ObjectBuilder<ExecuteAgentRequest>

Throws:

NullPointerException - if some of the required fields are null.