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

Class NodesUsageResponse

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportResponse

org.opensearch.action.ActionResponse

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

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

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class NodesUsageResponse
extends BaseNodesResponse<NodeUsage>
implements org.opensearch.common.xcontent.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 class org.opensearch.transport.TransportResponse

TransportResponse.Empty

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

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

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()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.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.opensearch.action.support.nodes.BaseNodesResponse

failures, getClusterName, getNodes, getNodesMap, hasFailures, writeTo

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Details

NodesUsageResponse

public NodesUsageResponse(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

NodesUsageResponse

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

Method Details

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 org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object