Class NodesInfoRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.nodes.NodesInfoRequest
public class NodesInfoRequest extends RequestBase
Returns information about nodes in the cluster.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NodesInfoRequest.Builder
Builder forNodesInfoRequest
.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 Endpoint<NodesInfoRequest,NodesInfoResponse,ErrorResponse>
_ENDPOINT
Endpoint "nodes.info
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
flatSettings()
If true, returns settings in flat format.Time
masterTimeout()
Period to wait for a connection to the master node.java.util.List<java.lang.String>
metric()
Limits the information returned to the specific metrics.java.util.List<java.lang.String>
nodeId()
Comma-separated list of node IDs or names used to limit returned information.static NodesInfoRequest
of(java.util.function.Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn)
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
Endpoint "nodes.info
".
-
-
Method Details
-
of
public static NodesInfoRequest of(java.util.function.Function<NodesInfoRequest.Builder,ObjectBuilder<NodesInfoRequest>> fn) -
flatSettings
@Nullable public final java.lang.Boolean flatSettings()If true, returns settings in flat format.API name:
flat_settings
-
masterTimeout
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 java.util.List<java.lang.String> metric()Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.API name:
metric
-
nodeId
public final java.util.List<java.lang.String> nodeId()Comma-separated list of node IDs or names used to limit returned information.API name:
node_id
-
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
-