Package org.opensearch.client.opensearch.knn

Class KnnStatsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.knn.KnnStatsRequest

All Implemented Interfaces:

ToCopyableBuilder<KnnStatsRequest.Builder,KnnStatsRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class KnnStatsRequest
extends RequestBase
implements ToCopyableBuilder<KnnStatsRequest.Builder,KnnStatsRequest>

Provides information about the current status of the k-NN plugin.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KnnStatsRequest.Builder	Builder for KnnStatsRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<KnnStatsRequest,KnnStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "knn.stats".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static KnnStatsRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	nodeId()	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.
static KnnStatsRequest	of(Function<KnnStatsRequest.Builder,ObjectBuilder<KnnStatsRequest>> fn)
final List<KnnStatName>	stat()	A comma-separated list of stats to retrieve; use _all or empty string to retrieve all stats.
final Time	timeout()	Operation timeout.
KnnStatsRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<KnnStatsRequest,KnnStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "knn.stats".

Method Details

of

public static KnnStatsRequest of(Function<KnnStatsRequest.Builder,ObjectBuilder<KnnStatsRequest>> fn)

nodeId

@Nonnull
public final List<String> nodeId()

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

stat

@Nonnull
public final List<KnnStatName> stat()

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

API name: stat

timeout

@Nullable
public final Time timeout()

Operation timeout.

API name: timeout

toBuilder

@Nonnull
public KnnStatsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<KnnStatsRequest.Builder,KnnStatsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static KnnStatsRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object