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

Class NodesUsageResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.nodes.BaseNodesResponse<NodeUsage>

org.elasticsearch.action.admin.cluster.node.usage.NodesUsageResponse

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentFragment

public class NodesUsageResponse
extends BaseNodesResponse<NodeUsage>
implements ToXContentFragment

The response for the nodes usage api which contains the individual usage statistics for all nodes queried.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
NodesUsageResponse(ClusterName clusterName, java.util.List<NodeUsage> nodes, java.util.List<FailedNodeException> failures)

Method Summary

Modifier and Type	Method	Description
protected java.util.List<NodeUsage>	readNodesFrom(StreamInput in)	Read the BaseNodesResponse.nodes from the stream.
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected void	writeNodesTo(StreamOutput out, java.util.List<NodeUsage> nodes)	Write the BaseNodesResponse.nodes to the stream.

Methods inherited from class org.elasticsearch.action.support.nodes.BaseNodesResponse

failures, getClusterName, getNodes, getNodesMap, hasFailures, readFrom, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

newWriteableReader

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Constructor Detail

NodesUsageResponse

public NodesUsageResponse(ClusterName clusterName,
                          java.util.List<NodeUsage> nodes,
                          java.util.List<FailedNodeException> failures)

Method Detail

readNodesFrom

protected java.util.List<NodeUsage> readNodesFrom(StreamInput in)
                                           throws java.io.IOException

Description copied from class: BaseNodesResponse

Read the BaseNodesResponse.nodes from the stream.

Specified by:

readNodesFrom in class BaseNodesResponse<NodeUsage>

Returns:

Never null.

Throws:

java.io.IOException

writeNodesTo

protected void writeNodesTo(StreamOutput out,
                            java.util.List<NodeUsage> nodes)
                     throws java.io.IOException

Description copied from class: BaseNodesResponse

Write the BaseNodesResponse.nodes to the stream.

Specified by:

writeNodesTo in class BaseNodesResponse<NodeUsage>

Throws:

java.io.IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object