Package org.opensearch.client.opensearch.cluster

Class ClusterStatsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.ClusterStatsRequest

All Implemented Interfaces:

ToCopyableBuilder<ClusterStatsRequest.Builder,ClusterStatsRequest>

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

Returns a high-level overview of cluster statistics.

Nested Class Summary

Nested Classes

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

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<ClusterStatsRequest,ClusterStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.stats".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static ClusterStatsRequest.Builder	builder()
boolean	equals(Object o)
final Boolean	flatSettings()	Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings.
int	hashCode()
final List<IndexMetric>	indexMetric()	A comma-separated list of index metric groups, for example, docs,store.
final List<Metric>	metric()	Limit the information returned to the specified metrics.
final List<String>	nodeId()	A comma-separated list of node IDs used to filter results.
static ClusterStatsRequest	of(Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)
final Time	timeout()	The amount of time to wait for each node to respond.
ClusterStatsRequest.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<ClusterStatsRequest,ClusterStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.stats".

Method Details

of

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

flatSettings

@Nullable
public final Boolean flatSettings()

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 List<IndexMetric> indexMetric()

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

API name: index_metric

metric

@Nonnull
public final List<Metric> metric()

Limit the information returned to the specified metrics.

API name: metric

nodeId

@Nonnull
public final List<String> nodeId()

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

API name: node_id

timeout

@Nullable
public final Time timeout()

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

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static ClusterStatsRequest.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