ClusterStatsRequest (java-client 7.16.3 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cluster.ClusterStatsRequest

public class ClusterStatsRequest
extends RequestBase

Returns high-level overview of cluster statistics.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class ClusterStatsRequest.Builder
Builder for ClusterStatsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
Field Summary

Fields

Modifier and Type Field Description

static Endpoint<ClusterStatsRequest,ClusterStatsResponse,ErrorResponse> _ENDPOINT
Endpoint "cluster.stats".

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`flatSettings()`	Return settings in flat format (default: false)
`java.util.List<java.lang.String>`	`nodeId()`	Comma-separated list of node filters used to limit returned information.
`static ClusterStatsRequest`	`of(java.util.function.Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)`
`Time`	`timeout()`	Period to wait for each node to respond.

Methods inherited from class java.lang.Object

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

Field Details
- _ENDPOINT
  
  public static final Endpoint<ClusterStatsRequest,ClusterStatsResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "cluster.stats".
Method Details
- of
  
  public static ClusterStatsRequest of(java.util.function.Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)
- flatSettings
  
  @Nullable public final java.lang.Boolean flatSettings()
  
  Return settings in flat format (default: false)
  API name: flat_settings
- nodeId
  
  public final java.util.List<java.lang.String> nodeId()
  
  Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.
  API name: node_id
- timeout
  
  @Nullable public final Time 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