Package org.opensearch.client.opensearch.knn

Class KnnStatsResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.nodes.NodesResponseBase.AbstractBuilder<KnnStatsResponse.Builder>

org.opensearch.client.opensearch.knn.KnnStatsResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

KnnStatsResponse

public static class KnnStatsResponse.Builder
extends NodesResponseBase.AbstractBuilder<KnnStatsResponse.Builder>
implements CopyableBuilder<KnnStatsResponse.Builder,KnnStatsResponse>

Builder for KnnStatsResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KnnStatsResponse	build()	Builds a KnnStatsResponse.
final KnnStatsResponse.Builder	circuitBreakerTriggered(Boolean value)	API name: circuit_breaker_triggered
final KnnStatsResponse.Builder	clusterName(String value)	API name: cluster_name
KnnStatsResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final KnnStatsResponse.Builder	modelIndexStatus(HealthStatus value)	API name: model_index_status
final KnnStatsResponse.Builder	nodes(String key, Function<NodeStats.Builder,ObjectBuilder<NodeStats>> fn)	API name: nodes
final KnnStatsResponse.Builder	nodes(String key, NodeStats value)	API name: nodes
final KnnStatsResponse.Builder	nodes(Map<String,NodeStats> map)	API name: nodes
protected KnnStatsResponse.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.nodes.NodesResponseBase.AbstractBuilder

nodeStats, nodeStats

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

Returns:

a new builder instance.

self

@Nonnull
protected KnnStatsResponse.Builder self()

Specified by:

self in class NodesResponseBase.AbstractBuilder<KnnStatsResponse.Builder>

circuitBreakerTriggered

@Nonnull
public final KnnStatsResponse.Builder circuitBreakerTriggered(@Nullable
 Boolean value)

API name: circuit_breaker_triggered

clusterName

@Nonnull
public final KnnStatsResponse.Builder clusterName(@Nullable
 String value)

API name: cluster_name

modelIndexStatus

@Nonnull
public final KnnStatsResponse.Builder modelIndexStatus(@Nullable
 HealthStatus value)

API name: model_index_status

nodes

@Nonnull
public final KnnStatsResponse.Builder nodes(Map<String,NodeStats> map)

API name: nodes

Adds all elements of map to nodes.

nodes

@Nonnull
public final KnnStatsResponse.Builder nodes(String key,
 NodeStats value)

API name: nodes

Adds an entry to nodes.

nodes

@Nonnull
public final KnnStatsResponse.Builder nodes(String key,
 Function<NodeStats.Builder,ObjectBuilder<NodeStats>> fn)

API name: nodes

Adds a value to nodes using a builder lambda.

build

@Nonnull
public KnnStatsResponse build()

Builds a KnnStatsResponse.

Specified by:

build in interface ObjectBuilder<KnnStatsResponse>

Throws:

NullPointerException - if some of the required fields are null.