Class NodesStatsRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.nodes.BaseNodesRequest<NodesStatsRequest>
org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.util.concurrent.RefCounted
,TaskAwareRequest
public class NodesStatsRequest extends BaseNodesRequest<NodesStatsRequest>
A request to get node (cluster) level stats.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NodesStatsRequest.Metric
An enumeration of the "core" sections of metrics that may be requested from the nodes stats 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 NodesStatsRequest()
NodesStatsRequest(java.lang.String... nodesIds)
Get stats from nodes based on the nodes ids specified.NodesStatsRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description NodesStatsRequest
addMetric(java.lang.String metric)
Add metricNodesStatsRequest
addMetrics(java.lang.String... metrics)
Add an array of metric namesNodesStatsRequest
all()
Sets all the request flags.NodesStatsRequest
clear()
Clears all the request flags.Task
createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)
Returns the task object that should be used to keep track of the processing of the request.CommonStatsFlags
indices()
Get indices.NodesStatsRequest
indices(boolean indices)
Should indices stats be returned.NodesStatsRequest
indices(CommonStatsFlags indices)
Set indices.NodesStatsRequest
removeMetric(java.lang.String metric)
Remove metricjava.util.Set<java.lang.String>
requestedMetrics()
Get the names of requested metrics, excluding indices, which are handled separately.void
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
getDescription, setParentTask
-
Constructor Details
-
NodesStatsRequest
public NodesStatsRequest() -
NodesStatsRequest
- Throws:
java.io.IOException
-
NodesStatsRequest
public NodesStatsRequest(java.lang.String... nodesIds)Get stats from nodes based on the nodes ids specified. If none are passed, stats for all nodes will be returned.
-
-
Method Details
-
all
Sets all the request flags. -
clear
Clears all the request flags. -
indices
Get indices. Handles separately from other metrics because it may or may not have submetrics.- Returns:
- flags indicating which indices stats to return
-
indices
Set indices. Handles separately from other metrics because it may or may not involve submetrics.- Parameters:
indices
- flags indicating which indices stats to return- Returns:
- This object, for request chaining.
-
indices
Should indices stats be returned. -
requestedMetrics
public java.util.Set<java.lang.String> requestedMetrics()Get the names of requested metrics, excluding indices, which are handled separately. -
addMetric
Add metric -
addMetrics
Add an array of metric names -
removeMetric
Remove metric -
createTask
public Task createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)Description copied from interface:TaskAwareRequest
Returns the task object that should be used to keep track of the processing of the request. -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classBaseNodesRequest<NodesStatsRequest>
- Throws:
java.io.IOException
-