Package org.opensearch.client.opensearch.ml

Class ToolItems.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.ToolItems.Builder

All Implemented Interfaces:

ObjectBuilder<ToolItems>

Enclosing class:

ToolItems

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

Builder for ToolItems.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ToolItems	build()	Builds a ToolItems.
ToolItems.Builder	metadata(java.lang.String key, JsonData value)	Adds an entry to metadata.
ToolItems.Builder	metadata(java.util.Map<java.lang.String,JsonData> map)	Adds all elements of map to metadata.
ToolItems.Builder	name(java.lang.String value)	API name: name
ToolItems.Builder	parameters(java.lang.String key, JsonData value)	API name: parameters
ToolItems.Builder	parameters(java.util.Map<java.lang.String,JsonData> map)	API name: parameters
ToolItems.Builder	type(java.lang.String value)	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

name

public final ToolItems.Builder name(@Nullable
                                    java.lang.String value)

API name: name

parameters

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

API name: parameters

Adds all elements of map to parameters.

parameters

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

API name: parameters

Adds an entry to parameters.

type

public final ToolItems.Builder type(@Nullable
                                    java.lang.String value)

API name: type

metadata

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

Adds all elements of map to metadata.

metadata

public final ToolItems.Builder metadata(java.lang.String key,
                                        JsonData value)

Adds an entry to metadata.

build

public ToolItems build()

Builds a ToolItems.

Specified by:

build in interface ObjectBuilder<ToolItems>

Throws:

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