Class ClusterStatsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.ClusterStatsRequest
Returns cluster statistics. It returns basic index metrics (shard numbers,
store size, memory usage) and information about the current nodes that form
the cluster (number, roles, os, jvm versions, memory usage, cpu and installed
plugins).
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<ClusterStatsRequest,
ClusterStatsResponse, ErrorResponse> Endpoint "cluster.stats
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iftrue
, returns settings in flat format.nodeId()
Comma-separated list of node filters used to limit returned information.static ClusterStatsRequest
final Time
timeout()
Period to wait for each node to respond.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cluster.stats
".
-
-
Method Details
-
of
public static ClusterStatsRequest of(Function<ClusterStatsRequest.Builder, ObjectBuilder<ClusterStatsRequest>> fn) -
flatSettings
Iftrue
, returns settings in flat format.API name:
flat_settings
-
nodeId
Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.API name:
node_id
-
timeout
Period 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
-