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 -
Method Summary
Modifier and TypeMethodDescriptionfinal Tool.BuilderAPI name:attributesfinal Tool.Builderattributes(ToolAttributes value) API name:attributesbuild()Builds aTool.copy()Create a new builderCopyableBuilderthat is a copy of this one.final Tool.Builderdescription(String value) The tool description.final Tool.BuilderAPI name:namefinal Tool.BuilderThe tool type.final Tool.BuilderAPI name:versionMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<Tool.Builder,Tool> - Returns:
- a new builder instance.
-
attributes
API name:attributes -
attributes
@Nonnull public final Tool.Builder attributes(Function<ToolAttributes.Builder, ObjectBuilder<ToolAttributes>> fn) API name:attributes -
description
The tool description.API name:
description -
name
API name:name -
type
The tool type.API name:
type -
version
API name:version -
build
Builds aTool.- Specified by:
buildin interfaceObjectBuilder<Tool>- Throws:
NullPointerException- if some of the required fields are null.
-