Package org.opensearch.client.opensearch.ml

Class RegisterAgentsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.RegisterAgentsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

RegisterAgentsRequest

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

Builder for RegisterAgentsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RegisterAgentsRequest.Builder	appType(String value)	API name: app_type
RegisterAgentsRequest	build()	Builds a RegisterAgentsRequest.
RegisterAgentsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RegisterAgentsRequest.Builder	description(String value)	API name: description
final RegisterAgentsRequest.Builder	llm(Function<LLM.Builder,ObjectBuilder<LLM>> fn)	API name: llm
final RegisterAgentsRequest.Builder	llm(LLM value)	API name: llm
final RegisterAgentsRequest.Builder	memory(Function<Memory.Builder,ObjectBuilder<Memory>> fn)	API name: memory
final RegisterAgentsRequest.Builder	memory(Memory value)	API name: memory
final RegisterAgentsRequest.Builder	name(String value)	Required - API name: name
final RegisterAgentsRequest.Builder	parameters(String key, JsonData value)	API name: parameters
final RegisterAgentsRequest.Builder	parameters(Map<String,JsonData> map)	API name: parameters
protected RegisterAgentsRequest.Builder	self()
final RegisterAgentsRequest.Builder	tools(Function<ToolItems.Builder,ObjectBuilder<ToolItems>> fn)	API name: tools
final RegisterAgentsRequest.Builder	tools(List<ToolItems> list)	API name: tools
final RegisterAgentsRequest.Builder	tools(ToolItems value, ToolItems... values)	API name: tools
final RegisterAgentsRequest.Builder	type(String value)	Required - API name: type

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

Returns:

a new builder instance.

self

@Nonnull
protected RegisterAgentsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RegisterAgentsRequest.Builder>

appType

@Nonnull
public final RegisterAgentsRequest.Builder appType(@Nullable
 String value)

API name: app_type

description

@Nonnull
public final RegisterAgentsRequest.Builder description(@Nullable
 String value)

API name: description

llm

@Nonnull
public final RegisterAgentsRequest.Builder llm(@Nullable
 LLM value)

API name: llm

llm

@Nonnull
public final RegisterAgentsRequest.Builder llm(Function<LLM.Builder,ObjectBuilder<LLM>> fn)

API name: llm

memory

@Nonnull
public final RegisterAgentsRequest.Builder memory(@Nullable
 Memory value)

API name: memory

memory

@Nonnull
public final RegisterAgentsRequest.Builder memory(Function<Memory.Builder,ObjectBuilder<Memory>> fn)

API name: memory

name

@Nonnull
public final RegisterAgentsRequest.Builder name(String value)

Required - API name: name

parameters

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

API name: parameters

Adds all elements of map to parameters.

parameters

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

API name: parameters

Adds an entry to parameters.

tools

@Nonnull
public final RegisterAgentsRequest.Builder tools(List<ToolItems> list)

API name: tools

Adds all elements of list to tools.

tools

@Nonnull
public final RegisterAgentsRequest.Builder tools(ToolItems value,
 ToolItems... values)

API name: tools

Adds one or more values to tools.

tools

@Nonnull
public final RegisterAgentsRequest.Builder tools(Function<ToolItems.Builder,ObjectBuilder<ToolItems>> fn)

API name: tools

Adds a value to tools using a builder lambda.

type

@Nonnull
public final RegisterAgentsRequest.Builder type(String value)

Required - API name: type

build

@Nonnull
public RegisterAgentsRequest build()

Builds a RegisterAgentsRequest.

Specified by:

build in interface ObjectBuilder<RegisterAgentsRequest>

Throws:

NullPointerException - if some of the required fields are null.