Package co.elastic.clients.elasticsearch.nodes

Class NodesInfoRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.nodes.NodesInfoRequest.Builder

All Implemented Interfaces:

WithJson<NodesInfoRequest.Builder>, ObjectBuilder<NodesInfoRequest>

Enclosing class:

NodesInfoRequest

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

Builder for NodesInfoRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NodesInfoRequest	build()	Builds a NodesInfoRequest.
final NodesInfoRequest.Builder	flatSettings(Boolean value)	If true, returns settings in flat format.
final NodesInfoRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final NodesInfoRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final NodesInfoRequest.Builder	metric(String value, String... values)	Limits the information returned to the specific metrics.
final NodesInfoRequest.Builder	metric(List<String> list)	Limits the information returned to the specific metrics.
final NodesInfoRequest.Builder	nodeId(String value, String... values)	Comma-separated list of node IDs or names used to limit returned information.
final NodesInfoRequest.Builder	nodeId(List<String> list)	Comma-separated list of node IDs or names used to limit returned information.
protected NodesInfoRequest.Builder	self()
final NodesInfoRequest.Builder	timeout(Time value)	Period to wait for a response.
final NodesInfoRequest.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

flatSettings

public final NodesInfoRequest.Builder flatSettings(@Nullable
 Boolean value)

If true, returns settings in flat format.

API name: flat_settings

masterTimeout

public final NodesInfoRequest.Builder masterTimeout(@Nullable
 Time value)

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

API name: master_timeout

masterTimeout

public final NodesInfoRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

API name: master_timeout

metric

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

Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

API name: metric

Adds all elements of list to metric.

metric

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

Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

API name: metric

Adds one or more values to metric.

nodeId

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

Comma-separated list of node IDs or names used to limit returned information.

API name: node_id

Adds all elements of list to nodeId.

nodeId

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

Comma-separated list of node IDs or names used to limit returned information.

API name: node_id

Adds one or more values to nodeId.

timeout

public final NodesInfoRequest.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 NodesInfoRequest.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 NodesInfoRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<NodesInfoRequest.Builder>

build

public NodesInfoRequest build()

Builds a NodesInfoRequest.

Specified by:

build in interface ObjectBuilder<NodesInfoRequest>

Throws:

NullPointerException - if some of the required fields are null.