Package co.elastic.clients.elasticsearch.nodes

Class NodesUsageRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<NodesUsageRequest.Builder>

co.elastic.clients.elasticsearch.nodes.NodesUsageRequest.Builder

All Implemented Interfaces:

WithJson<NodesUsageRequest.Builder>, ObjectBuilder<NodesUsageRequest>

Enclosing class:

NodesUsageRequest

public static class NodesUsageRequest.Builder
extends RequestBase.AbstractBuilder<NodesUsageRequest.Builder>
implements ObjectBuilder<NodesUsageRequest>

Builder for NodesUsageRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

metric

public final NodesUsageRequest.Builder metric(List<String> list)

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

API name: metric

Adds all elements of list to metric.

metric

public final NodesUsageRequest.Builder metric(String value,
 String... values)

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

API name: metric

Adds one or more values to metric.

nodeId

public final NodesUsageRequest.Builder nodeId(List<String> list)

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

Adds all elements of list to nodeId.

nodeId

public final NodesUsageRequest.Builder nodeId(String value,
 String... values)

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

Adds one or more values to nodeId.

timeout

public final NodesUsageRequest.Builder timeout(@Nullable
 Time value)

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

timeout

public final NodesUsageRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

self

protected NodesUsageRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<NodesUsageRequest.Builder>

build

public NodesUsageRequest build()

Builds a NodesUsageRequest.

Specified by:

build in interface ObjectBuilder<NodesUsageRequest>

Throws:

NullPointerException - if some of the required fields are null.