Package org.opensearch.client.opensearch.ml

Class ExecuteAgentStreamRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.ExecuteAgentStreamRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ExecuteAgentStreamRequest

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

Builder for ExecuteAgentStreamRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ExecuteAgentStreamRequest.Builder	agentId(String value)	Required - API name: agent_id
ExecuteAgentStreamRequest	build()	Builds a ExecuteAgentStreamRequest.
ExecuteAgentStreamRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ExecuteAgentStreamRequest.Builder	parameters(String key, JsonData value)	Required - API name: parameters
final ExecuteAgentStreamRequest.Builder	parameters(Map<String,JsonData> map)	Required - API name: parameters
protected ExecuteAgentStreamRequest.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 ExecuteAgentStreamRequest.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<ExecuteAgentStreamRequest.Builder,ExecuteAgentStreamRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ExecuteAgentStreamRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExecuteAgentStreamRequest.Builder>

agentId

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

Required - API name: agent_id

parameters

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

Required - API name: parameters

Adds all elements of map to parameters.

parameters

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

Required - API name: parameters

Adds an entry to parameters.

build

@Nonnull
public ExecuteAgentStreamRequest build()

Builds a ExecuteAgentStreamRequest.

Specified by:

build in interface ObjectBuilder<ExecuteAgentStreamRequest>

Throws:

NullPointerException - if some of the required fields are null.