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:

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

Enclosing class:

ToolItems

public static class ToolItems.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ToolItems.Builder,ToolItems>

Builder for ToolItems.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ToolItems.Builder	attributes(Function<ToolAttributes.Builder,ObjectBuilder<ToolAttributes>> fn)	API name: attributes
final ToolItems.Builder	attributes(ToolAttributes value)	API name: attributes
ToolItems	build()	Builds a ToolItems.
ToolItems.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ToolItems.Builder	description(String value)	API name: description
final ToolItems.Builder	includeOutputInAgentResponse(Boolean value)	API name: include_output_in_agent_response
final ToolItems.Builder	metadata(String key, JsonData value)	Adds an entry to metadata.
final ToolItems.Builder	metadata(Map<String,JsonData> map)	Adds all elements of map to metadata.
final ToolItems.Builder	name(String value)	API name: name
final ToolItems.Builder	parameters(String key, JsonData value)	API name: parameters
final ToolItems.Builder	parameters(Map<String,JsonData> map)	API name: parameters
final ToolItems.Builder	type(String value)	API name: type

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

Returns:

a new builder instance.

attributes

@Nonnull
public final ToolItems.Builder attributes(@Nullable
 ToolAttributes value)

API name: attributes

attributes

@Nonnull
public final ToolItems.Builder attributes(Function<ToolAttributes.Builder,ObjectBuilder<ToolAttributes>> fn)

API name: attributes

description

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

API name: description

includeOutputInAgentResponse

@Nonnull
public final ToolItems.Builder includeOutputInAgentResponse(@Nullable
 Boolean value)

API name: include_output_in_agent_response

metadata

@Nonnull
public final ToolItems.Builder metadata(Map<String,JsonData> map)

Adds all elements of map to metadata.

metadata

@Nonnull
public final ToolItems.Builder metadata(String key,
 JsonData value)

Adds an entry to metadata.

name

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

API name: name

parameters

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

API name: parameters

Adds all elements of map to parameters.

parameters

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

API name: parameters

Adds an entry to parameters.

type

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

API name: type

build

@Nonnull
public ToolItems build()

Builds a ToolItems.

Specified by:

build in interface ObjectBuilder<ToolItems>

Throws:

NullPointerException - if some of the required fields are null.