Class NodesInfoRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.nodes.BaseNodesRequest<NodesInfoRequest>
org.elasticsearch.action.admin.cluster.node.info.NodesInfoRequest
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.util.concurrent.RefCounted
,TaskAwareRequest
public class NodesInfoRequest extends BaseNodesRequest<NodesInfoRequest>
A request to get node (cluster) level information.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NodesInfoRequest.Metric
An enumeration of the "core" sections of metrics that may be requested from the nodes information endpoint.Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Constructor Summary
Constructors Constructor Description NodesInfoRequest(java.lang.String... nodesIds)
Get information from nodes based on the nodes ids specified.NodesInfoRequest(StreamInput in)
Create a new NodeInfoRequest from aStreamInput
object. -
Method Summary
Modifier and Type Method Description NodesInfoRequest
addMetric(java.lang.String metric)
Add metricNodesInfoRequest
addMetrics(java.lang.String... metrics)
Add multiple metricsNodesInfoRequest
all()
Sets to return all the data.NodesInfoRequest
clear()
Clears all info flags.NodesInfoRequest
removeMetric(java.lang.String metric)
Remove metricjava.util.Set<java.lang.String>
requestedMetrics()
Get the names of requested metricsvoid
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.nodes.BaseNodesRequest
concreteNodes, nodesIds, nodesIds, setConcreteNodes, timeout, timeout, timeout, validate
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
NodesInfoRequest
Create a new NodeInfoRequest from aStreamInput
object.- Parameters:
in
- A stream input object.- Throws:
java.io.IOException
- if the stream cannot be deserialized.
-
NodesInfoRequest
public NodesInfoRequest(java.lang.String... nodesIds)Get information from nodes based on the nodes ids specified. If none are passed, information for all nodes will be returned.
-
-
Method Details
-
clear
Clears all info flags. -
all
Sets to return all the data. -
requestedMetrics
public java.util.Set<java.lang.String> requestedMetrics()Get the names of requested metrics -
addMetric
Add metric -
addMetrics
Add multiple metrics -
removeMetric
Remove metric -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classBaseNodesRequest<NodesInfoRequest>
- Throws:
java.io.IOException
-