Package org.opensearch.client.opensearch.ml

Class RegisterAgentsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<RegisterAgentsRequest>

Enclosing class:

RegisterAgentsRequest

public static class RegisterAgentsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<RegisterAgentsRequest>

Builder for RegisterAgentsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RegisterAgentsRequest.Builder	appType(java.lang.String value)	API name: app_type
RegisterAgentsRequest	build()	Builds a RegisterAgentsRequest.
RegisterAgentsRequest.Builder	description(java.lang.String value)	API name: description
RegisterAgentsRequest.Builder	llm(java.util.function.Function<LLM.Builder,ObjectBuilder<LLM>> fn)	API name: llm
RegisterAgentsRequest.Builder	llm(LLM value)	API name: llm
RegisterAgentsRequest.Builder	memory(java.util.function.Function<Memory.Builder,ObjectBuilder<Memory>> fn)	API name: memory
RegisterAgentsRequest.Builder	memory(Memory value)	API name: memory
RegisterAgentsRequest.Builder	name(java.lang.String value)	Required - API name: name
RegisterAgentsRequest.Builder	parameters(java.lang.String key, JsonData value)	API name: parameters
RegisterAgentsRequest.Builder	parameters(java.util.Map<java.lang.String,JsonData> map)	API name: parameters
RegisterAgentsRequest.Builder	tools(java.util.function.Function<ToolItems.Builder,ObjectBuilder<ToolItems>> fn)	API name: tools
RegisterAgentsRequest.Builder	tools(java.util.List<ToolItems> list)	API name: tools
RegisterAgentsRequest.Builder	tools(ToolItems value, ToolItems... values)	API name: tools
RegisterAgentsRequest.Builder	type(java.lang.String value)	Required - API name: type

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

appType

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

API name: app_type

description

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

API name: description

llm

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

API name: llm

llm

public final RegisterAgentsRequest.Builder llm(java.util.function.Function<LLM.Builder,ObjectBuilder<LLM>> fn)

API name: llm

memory

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

API name: memory

memory

public final RegisterAgentsRequest.Builder memory(java.util.function.Function<Memory.Builder,ObjectBuilder<Memory>> fn)

API name: memory

name

public final RegisterAgentsRequest.Builder name(java.lang.String value)

Required - API name: name

parameters

public final RegisterAgentsRequest.Builder parameters(java.util.Map<java.lang.String,JsonData> map)

API name: parameters

Adds all elements of map to parameters.

parameters

public final RegisterAgentsRequest.Builder parameters(java.lang.String key,
                                                      JsonData value)

API name: parameters

Adds an entry to parameters.

tools

public final RegisterAgentsRequest.Builder tools(java.util.List<ToolItems> list)

API name: tools

Adds all elements of list to tools.

tools

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

API name: tools

Adds one or more values to tools.

tools

public final RegisterAgentsRequest.Builder tools(java.util.function.Function<ToolItems.Builder,ObjectBuilder<ToolItems>> fn)

API name: tools

Adds a value to tools using a builder lambda.

type

public final RegisterAgentsRequest.Builder type(java.lang.String value)

Required - API name: type

build

public RegisterAgentsRequest build()

Builds a RegisterAgentsRequest.

Specified by:

build in interface ObjectBuilder<RegisterAgentsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.