Module org.elasticsearch.server
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,RefCounted,TaskAwareRequest
A request to get node (cluster) level stats.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionNodesStatsRequest(String... nodesIds) Get stats from nodes based on the nodes ids specified.NodesStatsRequest(NodesStatsRequestParameters nodesStatsRequestParameters, String... nodesIds) -
Method Summary
Modifier and TypeMethodDescriptionAdd metricaddMetrics(List<NodesStatsRequestParameters.Metric> metrics) addMetrics(NodesStatsRequestParameters.Metric... metrics) Add an array of metric namesall()Sets all the request flags.clear()Clears all the request flags.Returns the task object that should be used to keep track of the processing of the request.Returns optional description of the request to be displayed by the task managerbooleanindices()Get nodesStatsMetrics.indices().indices(boolean indices) Should indices stats be returned.indices(CommonStatsFlags indices) Set nodesStatsMetrics.indices().Remove metricGet the names of requested metrics, excluding indices, which are handled separately.voidsetIncludeShardsStats(boolean includeShardsStats) Methods inherited from class org.elasticsearch.action.support.nodes.BaseNodesRequest
nodesIds, timeout, timeout, validate, writeToMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
setParentTask
-
Constructor Details
-
NodesStatsRequest
public NodesStatsRequest() -
NodesStatsRequest
Get stats from nodes based on the nodes ids specified. If none are passed, stats for all nodes will be returned. -
NodesStatsRequest
public NodesStatsRequest(NodesStatsRequestParameters nodesStatsRequestParameters, String... nodesIds)
-
-
Method Details
-
all
Sets all the request flags. -
clear
Clears all the request flags. -
indices
Get nodesStatsMetrics.indices(). Handles separately from other metrics because it may or may not have submetrics.- Returns:
- flags indicating which indices stats to return
-
indices
Set nodesStatsMetrics.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
Get the names of requested metrics, excluding indices, which are handled separately. -
addMetric
Add metric -
addMetrics
Add an array of metric names -
addMetrics
-
removeMetric
Remove metric -
getDescription
Description copied from interface:TaskAwareRequestReturns optional description of the request to be displayed by the task manager -
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequestReturns the task object that should be used to keep track of the processing of the request. -
includeShardsStats
public boolean includeShardsStats() -
setIncludeShardsStats
public void setIncludeShardsStats(boolean includeShardsStats) -
getNodesStatsRequestParameters
-