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

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, 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 enum	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(String... nodesIds)	Get information from nodes based on the nodes ids specified.
NodesInfoRequest(StreamInput in)	Create a new NodeInfoRequest from a StreamInput object.

Method Summary

Modifier and Type	Method	Description
NodesInfoRequest	addMetric(String metric)	Add metric
NodesInfoRequest	addMetrics(String... metrics)	Add multiple metrics
NodesInfoRequest	all()	Sets to return all the data.
NodesInfoRequest	clear()	Clears all info flags.
NodesInfoRequest	removeMetric(String metric)	Remove metric
Set<String>	requestedMetrics()	Get the names of requested metrics
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, hasReferences, 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

public NodesInfoRequest(StreamInput in)
                 throws IOException

Create a new NodeInfoRequest from a StreamInput object.

Parameters:

in - A stream input object.

Throws:

IOException - if the stream cannot be deserialized.

NodesInfoRequest

public NodesInfoRequest(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

public NodesInfoRequest clear()

Clears all info flags.

all

public NodesInfoRequest all()

Sets to return all the data.

requestedMetrics

public Set<String> requestedMetrics()

Get the names of requested metrics

addMetric

public NodesInfoRequest addMetric(String metric)

Add metric

addMetrics

public NodesInfoRequest addMetrics(String... metrics)

Add multiple metrics

removeMetric

public NodesInfoRequest removeMetric(String metric)

Remove metric

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseNodesRequest<NodesInfoRequest>

Throws:

IOException