NodesUsageRequest (java-client 8.5.0 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.nodes.NodesUsageRequest

public class NodesUsageRequest
extends RequestBase

Returns low-level information about REST actions usage on nodes.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class NodesUsageRequest.Builder
Builder for NodesUsageRequest.

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<NodesUsageRequest,NodesUsageResponse,ErrorResponse> _ENDPOINT
Endpoint "nodes.usage".

Method Summary

Modifier and Type	Method	Description
`java.util.List<java.lang.String>`	`metric()`	Limit the information returned to the specified metrics
`java.util.List<java.lang.String>`	`nodeId()`	A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
`static NodesUsageRequest`	`of(java.util.function.Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)`
`Time`	`timeout()`	Explicit operation timeout

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details
- _ENDPOINT
  
  public static final Endpoint<NodesUsageRequest,NodesUsageResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "nodes.usage".
Method Details
- of
  
  public static NodesUsageRequest of(java.util.function.Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)
- metric
  
  public final java.util.List<java.lang.String> metric()
  
  Limit the information returned to the specified metrics
  API name: metric
- nodeId
  
  public final java.util.List<java.lang.String> nodeId()
  
  A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
  API name: node_id
- timeout
  
  @Nullable public final Time timeout()
  
  Explicit operation timeout
  API name: timeout