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 aClusterStatsRequest
.ClusterStatsRequest.Builder
flatSettings(java.lang.Boolean value)
Return settings in flat format (default: false)ClusterStatsRequest.Builder
nodeId(java.lang.String value, java.lang.String... values)
Comma-separated list of node filters used to limit returned information.ClusterStatsRequest.Builder
nodeId(java.util.List<java.lang.String> list)
Comma-separated list of node filters used to limit returned information.protected ClusterStatsRequest.Builder
self()
ClusterStatsRequest.Builder
timeout(Time value)
Period to wait for each node to respond.ClusterStatsRequest.Builder
timeout(java.util.function.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
flatSettings
Return settings in flat format (default: false)API name:
flat_settings
-
nodeId
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
tonodeId
. -
nodeId
public final ClusterStatsRequest.Builder nodeId(java.lang.String value, java.lang.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
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(java.util.function.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
- Specified by:
self
in classRequestBase.AbstractBuilder<ClusterStatsRequest.Builder>
-
build
Builds aClusterStatsRequest
.- Specified by:
build
in interfaceObjectBuilder<ClusterStatsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-