Package org.opensearch.client.opensearch.knn

Class KnnStatsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<KnnStatsRequest.Builder>

org.opensearch.client.opensearch.knn.KnnStatsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

KnnStatsRequest

public static class KnnStatsRequest.Builder
extends RequestBase.AbstractBuilder<KnnStatsRequest.Builder>
implements CopyableBuilder<KnnStatsRequest.Builder,KnnStatsRequest>

Builder for KnnStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KnnStatsRequest	build()	Builds a KnnStatsRequest.
KnnStatsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final KnnStatsRequest.Builder	nodeId(String value, String... values)	A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.
final KnnStatsRequest.Builder	nodeId(List<String> list)	A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.
protected KnnStatsRequest.Builder	self()
final KnnStatsRequest.Builder	stat(List<KnnStatName> list)	A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.
final KnnStatsRequest.Builder	stat(KnnStatName value, KnnStatName... values)	A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.
final KnnStatsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout.
final KnnStatsRequest.Builder	timeout(Time value)	Operation timeout.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Returns:

a new builder instance.

self

@Nonnull
protected KnnStatsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<KnnStatsRequest.Builder>

nodeId

@Nonnull
public final KnnStatsRequest.Builder nodeId(List<String> list)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

API name: node_id

Adds all elements of list to nodeId.

nodeId

@Nonnull
public final KnnStatsRequest.Builder nodeId(String value,
 String... values)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

API name: node_id

Adds one or more values to nodeId.

stat

@Nonnull
public final KnnStatsRequest.Builder stat(List<KnnStatName> list)

A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.

API name: stat

Adds all elements of list to stat.

stat

@Nonnull
public final KnnStatsRequest.Builder stat(KnnStatName value,
 KnnStatName... values)

A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.

API name: stat

Adds one or more values to stat.

timeout

@Nonnull
public final KnnStatsRequest.Builder timeout(@Nullable
 Time value)

Operation timeout.

API name: timeout

timeout

@Nonnull
public final KnnStatsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout.

API name: timeout

build

@Nonnull
public KnnStatsRequest build()

Builds a KnnStatsRequest.

Specified by:

build in interface ObjectBuilder<KnnStatsRequest>

Throws:

NullPointerException - if some of the required fields are null.