Package org.opensearch.client.opensearch.knn

Class KnnMethod.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.knn.KnnMethod.Builder

All Implemented Interfaces:

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

Enclosing class:

KnnMethod

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

Builder for KnnMethod.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KnnMethod	build()	Builds a KnnMethod.
KnnMethod.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final KnnMethod.Builder	engine(String value)	API name: engine
final KnnMethod.Builder	name(String value)	Required - API name: name
final KnnMethod.Builder	parameters(String key, JsonData value)	API name: parameters
final KnnMethod.Builder	parameters(Map<String,JsonData> map)	API name: parameters
final KnnMethod.Builder	spaceType(String value)	API name: space_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 KnnMethod.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<KnnMethod.Builder,KnnMethod>

Returns:

a new builder instance.

engine

@Nonnull
public final KnnMethod.Builder engine(@Nullable
 String value)

API name: engine

name

@Nonnull
public final KnnMethod.Builder name(String value)

Required - API name: name

parameters

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

API name: parameters

Adds all elements of map to parameters.

parameters

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

API name: parameters

Adds an entry to parameters.

spaceType

@Nonnull
public final KnnMethod.Builder spaceType(@Nullable
 String value)

API name: space_type

build

@Nonnull
public KnnMethod build()

Builds a KnnMethod.

Specified by:

build in interface ObjectBuilder<KnnMethod>

Throws:

NullPointerException - if some of the required fields are null.