Package co.elastic.clients.elasticsearch.nodes

Class NodesUsageRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.nodes.NodesUsageRequest

public class NodesUsageRequest
extends RequestBase

Returns information on the usage of features.

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

Method Summary

Modifier and Type	Method	Description
final List<String>	metric()	Limits the information returned to the specific metrics.
final List<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(Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)
final Time	timeout()	Period to wait for a response.

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(Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)

metric

public final List<String> metric()

Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

API name: metric

nodeId

public final List<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()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout