Package org.opensearch.action.admin.cluster.stats

Class ClusterStatsNodeResponse

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.core.transport.TransportResponse

org.opensearch.action.support.nodes.BaseNodeResponse

org.opensearch.action.admin.cluster.stats.ClusterStatsNodeResponse

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable

public class ClusterStatsNodeResponse
extends BaseNodeResponse

Transport action for obtaining cluster stats from node level

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusterStatsNodeResponse.AggregatedIndexStats	Node level statistics used for ClusterStatsIndices for _cluster/stats call.
class	ClusterStatsNodeResponse.AggregatedNodeLevelStats	Node level statistics used for ClusterStatsIndices for _cluster/stats call.

Nested classes/interfaces inherited from class org.opensearch.core.transport.TransportResponse

org.opensearch.core.transport.TransportResponse.Empty

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
ClusterStatsNodeResponse(DiscoveryNode node, ClusterHealthStatus clusterStatus, NodeInfo nodeInfo, NodeStats nodeStats, ShardStats[] shardsStats)
ClusterStatsNodeResponse(DiscoveryNode node, ClusterHealthStatus clusterStatus, NodeInfo nodeInfo, NodeStats nodeStats, ShardStats[] shardsStats, boolean useAggregatedNodeLevelResponses)
ClusterStatsNodeResponse(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
ClusterHealthStatus	clusterStatus()	Cluster Health Status, only populated on cluster-manager nodes.
ClusterStatsNodeResponse.AggregatedNodeLevelStats	getAggregatedNodeLevelStats()
NodeInfo	nodeInfo()
NodeStats	nodeStats()
static ClusterStatsNodeResponse	readNodeResponse(org.opensearch.core.common.io.stream.StreamInput in)
ShardStats[]	shardsStats()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.support.nodes.BaseNodeResponse

getNode

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Constructor Details

ClusterStatsNodeResponse

public ClusterStatsNodeResponse(org.opensearch.core.common.io.stream.StreamInput in)
                         throws IOException

Throws:

IOException

ClusterStatsNodeResponse

public ClusterStatsNodeResponse(DiscoveryNode node,
 @Nullable
 ClusterHealthStatus clusterStatus,
 NodeInfo nodeInfo,
 NodeStats nodeStats,
 ShardStats[] shardsStats)

ClusterStatsNodeResponse

public ClusterStatsNodeResponse(DiscoveryNode node,
 @Nullable
 ClusterHealthStatus clusterStatus,
 NodeInfo nodeInfo,
 NodeStats nodeStats,
 ShardStats[] shardsStats,
 boolean useAggregatedNodeLevelResponses)

Method Details

nodeInfo

public NodeInfo nodeInfo()

nodeStats

public NodeStats nodeStats()

clusterStatus

@Nullable
public ClusterHealthStatus clusterStatus()

Cluster Health Status, only populated on cluster-manager nodes.

shardsStats

public ShardStats[] shardsStats()

getAggregatedNodeLevelStats

public ClusterStatsNodeResponse.AggregatedNodeLevelStats getAggregatedNodeLevelStats()

readNodeResponse

public static ClusterStatsNodeResponse readNodeResponse(org.opensearch.core.common.io.stream.StreamInput in)
                                                 throws IOException

Throws:

IOException

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class BaseNodeResponse

Throws:

IOException