Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.node.stats

Class NodesStatsRequestParameters

java.lang.Object

org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequestParameters

All Implemented Interfaces:

Writeable

public class NodesStatsRequestParameters
extends Object
implements Writeable

This class encapsulates the metrics and other information needed to define scope when we are requesting node stats.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NodesStatsRequestParameters.Metric	An enumeration of the "core" sections of metrics that may be requested from the nodes stats endpoint.

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
NodesStatsRequestParameters()
NodesStatsRequestParameters(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	includeShardsStats()
CommonStatsFlags	indices()
Set<String>	requestedMetrics()
void	setIncludeShardsStats(boolean includeShardsStats)
void	setIndices(CommonStatsFlags indices)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NodesStatsRequestParameters

public NodesStatsRequestParameters()

NodesStatsRequestParameters

public NodesStatsRequestParameters(StreamInput in)
                            throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

indices

public CommonStatsFlags indices()

setIndices

public void setIndices(CommonStatsFlags indices)

requestedMetrics

public Set<String> requestedMetrics()

includeShardsStats

public boolean includeShardsStats()

setIncludeShardsStats

public void setIncludeShardsStats(boolean includeShardsStats)