Package org.opensearch.client.opensearch.ml

Class Tool.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.Tool.Builder

All Implemented Interfaces:

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

Enclosing class:

Tool

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

Builder for Tool.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Tool	build()	Builds a Tool.
Tool.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
Tool.Builder	description(java.lang.String value)	The tool description.
Tool.Builder	name(java.lang.String value)	API name: name
Tool.Builder	type(java.lang.String value)	The tool type.
Tool.Builder	version(java.lang.String value)	API name: version

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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 Detail

Builder

public Builder()

Method Detail

copy

@Nonnull
public Tool.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<Tool.Builder,Tool>

Returns:

a new builder instance.

description

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

The tool description.

API name: description

name

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

API name: name

type

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

The tool type.

API name: type

version

@Nonnull
public final Tool.Builder version(@Nullable
                                  java.lang.String value)

API name: version

build

@Nonnull
public Tool build()

Builds a Tool.

Specified by:

build in interface ObjectBuilder<Tool>

Throws:

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