Package org.opensearch.client.opensearch.cluster

Class ClusterStatsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cluster.ClusterStatsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ClusterStatsRequest

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

Builder for ClusterStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterStatsRequest	build()	Builds a ClusterStatsRequest.
ClusterStatsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClusterStatsRequest.Builder	flatSettings(Boolean value)	Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings.
final ClusterStatsRequest.Builder	indexMetric(List<IndexMetric> list)	A comma-separated list of index metric groups, for example, docs,store.
final ClusterStatsRequest.Builder	indexMetric(IndexMetric value, IndexMetric... values)	A comma-separated list of index metric groups, for example, docs,store.
final ClusterStatsRequest.Builder	metric(List<Metric> list)	Limit the information returned to the specified metrics.
final ClusterStatsRequest.Builder	metric(Metric value, Metric... values)	Limit the information returned to the specified metrics.
final ClusterStatsRequest.Builder	nodeId(String value, String... values)	A comma-separated list of node IDs used to filter results.
final ClusterStatsRequest.Builder	nodeId(List<String> list)	A comma-separated list of node IDs used to filter results.
protected ClusterStatsRequest.Builder	self()
final ClusterStatsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for each node to respond.
final ClusterStatsRequest.Builder	timeout(Time value)	The amount of time to wait for each node to respond.

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

Returns:

a new builder instance.

self

@Nonnull
protected ClusterStatsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ClusterStatsRequest.Builder>

flatSettings

@Nonnull
public final ClusterStatsRequest.Builder flatSettings(@Nullable
 Boolean value)

Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500".

API name: flat_settings

indexMetric

@Nonnull
public final ClusterStatsRequest.Builder indexMetric(List<IndexMetric> list)

A comma-separated list of index metric groups, for example, docs,store.

API name: index_metric

Adds all elements of list to indexMetric.

indexMetric

@Nonnull
public final ClusterStatsRequest.Builder indexMetric(IndexMetric value,
 IndexMetric... values)

A comma-separated list of index metric groups, for example, docs,store.

API name: index_metric

Adds one or more values to indexMetric.

metric

@Nonnull
public final ClusterStatsRequest.Builder metric(List<Metric> list)

Limit the information returned to the specified metrics.

API name: metric

Adds all elements of list to metric.

metric

@Nonnull
public final ClusterStatsRequest.Builder metric(Metric value,
 Metric... values)

Limit the information returned to the specified metrics.

API name: metric

Adds one or more values to metric.

nodeId

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

A comma-separated list of node IDs used to filter results. Supports node filters.

API name: node_id

Adds all elements of list to nodeId.

nodeId

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

A comma-separated list of node IDs used to filter results. Supports node filters.

API name: node_id

Adds one or more values to nodeId.

timeout

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

The amount of time to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's _nodes.failed property. Defaults to no timeout.

API name: timeout

timeout

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

The amount of time to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's _nodes.failed property. Defaults to no timeout.

API name: timeout

build

@Nonnull
public ClusterStatsRequest build()

Builds a ClusterStatsRequest.

Specified by:

build in interface ObjectBuilder<ClusterStatsRequest>

Throws:

NullPointerException - if some of the required fields are null.