Package org.opensearch.client.opensearch.ml

Class ToolAttributes.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.ToolAttributes.Builder

All Implemented Interfaces:

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

Enclosing class:

ToolAttributes

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

Builder for ToolAttributes.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ToolAttributes.Builder	attributes(java.lang.String key, JsonData value)	Adds an entry to attributes.
ToolAttributes.Builder	attributes(java.util.Map<java.lang.String,JsonData> map)	Adds all elements of map to attributes.
ToolAttributes	build()	Builds a ToolAttributes.
ToolAttributes.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
ToolAttributes.Builder	inputSchema(java.lang.String value)	API name: input_schema
ToolAttributes.Builder	strict(java.lang.Boolean value)	API name: strict

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

Returns:

a new builder instance.

attributes

@Nonnull
public final ToolAttributes.Builder attributes(java.util.Map<java.lang.String,JsonData> map)

Adds all elements of map to attributes.

attributes

@Nonnull
public final ToolAttributes.Builder attributes(java.lang.String key,
                                               JsonData value)

Adds an entry to attributes.

inputSchema

@Nonnull
public final ToolAttributes.Builder inputSchema(@Nullable
                                                java.lang.String value)

API name: input_schema

strict

@Nonnull
public final ToolAttributes.Builder strict(@Nullable
                                           java.lang.Boolean value)

API name: strict

build

@Nonnull
public ToolAttributes build()

Builds a ToolAttributes.

Specified by:

build in interface ObjectBuilder<ToolAttributes>

Throws:

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