Package co.elastic.clients.elasticsearch.cluster

Class ClusterStatsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.cluster.ClusterStatsRequest.Builder

All Implemented Interfaces:

WithJson<ClusterStatsRequest.Builder>, ObjectBuilder<ClusterStatsRequest>

Enclosing class:

ClusterStatsRequest

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

Builder for ClusterStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterStatsRequest	build()	Builds a ClusterStatsRequest.
final ClusterStatsRequest.Builder	includeRemotes(Boolean value)	Include remote cluster data into the response
final ClusterStatsRequest.Builder	nodeId(String value, String... values)	Comma-separated list of node filters used to limit returned information.
final ClusterStatsRequest.Builder	nodeId(List<String> list)	Comma-separated list of node filters used to limit returned information.
protected ClusterStatsRequest.Builder	self()
final ClusterStatsRequest.Builder	timeout(Time value)	Period to wait for each node to respond.
final ClusterStatsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for each node to respond.

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

includeRemotes

public final ClusterStatsRequest.Builder includeRemotes(@Nullable
 Boolean value)

Include remote cluster data into the response

API name: include_remotes

nodeId

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

Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.

API name: node_id

Adds all elements of list to nodeId.

nodeId

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

Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.

API name: node_id

Adds one or more values to nodeId.

timeout

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

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

timeout

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

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

self

protected ClusterStatsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ClusterStatsRequest.Builder>

build

public ClusterStatsRequest build()

Builds a ClusterStatsRequest.

Specified by:

build in interface ObjectBuilder<ClusterStatsRequest>

Throws:

NullPointerException - if some of the required fields are null.