Package org.opensearch.action.admin.indices.stats

Class TransportIndicesStatsAction

java.lang.Object

org.opensearch.action.support.TransportAction<IndicesStatsRequest,IndicesStatsResponse>

org.opensearch.action.support.HandledTransportAction<IndicesStatsRequest,IndicesStatsResponse>

org.opensearch.action.support.broadcast.node.TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

org.opensearch.action.admin.indices.stats.TransportIndicesStatsAction

public class TransportIndicesStatsAction
extends TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

Transport action for retrieving indices stats

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.action.support.broadcast.node.TransportBroadcastByNodeAction

TransportBroadcastByNodeAction.AsyncAction, TransportBroadcastByNodeAction.EmptyResult, TransportBroadcastByNodeAction.NodeRequest

Field Summary

Fields inherited from class org.opensearch.action.support.TransportAction

actionName, logger, taskManager

Constructor Summary

Constructors

Constructor	Description
TransportIndicesStatsAction(ClusterService clusterService, TransportService transportService, IndicesService indicesService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver)

Method Summary

Modifier and Type	Method	Description
protected ClusterBlockException	checkGlobalBlock(ClusterState state, IndicesStatsRequest request)	Executes a global block check before polling the cluster state.
protected ClusterBlockException	checkRequestBlock(ClusterState state, IndicesStatsRequest request, String[] concreteIndices)	Executes a global request-level check before polling the cluster state.
protected IndicesStatsResponse	newResponse(IndicesStatsRequest request, int totalShards, int successfulShards, int failedShards, List<ShardStats> responses, List<org.opensearch.core.action.support.DefaultShardOperationFailedException> shardFailures, ClusterState clusterState)	Creates a new response to the underlying request.
protected IndicesStatsRequest	readRequestFrom(org.opensearch.core.common.io.stream.StreamInput in)	Deserialize a request from an input stream
protected ShardStats	readShardResult(org.opensearch.core.common.io.stream.StreamInput in)	Deserialize a shard-level result from an input stream
protected ShardStats	shardOperation(IndicesStatsRequest request, ShardRouting shardRouting)	Executes the shard-level operation.
protected ShardsIterator	shards(ClusterState clusterState, IndicesStatsRequest request, String[] concreteIndices)	Status goes across *all* shards.

Methods inherited from class org.opensearch.action.support.broadcast.node.TransportBroadcastByNodeAction

doExecute, getShardRoutingsFromInputStream, resolveConcreteIndexNames

Methods inherited from class org.opensearch.action.support.TransportAction

execute, execute, execute

Methods inherited from class java.lang.Object

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

Constructor Details

TransportIndicesStatsAction

@Inject
public TransportIndicesStatsAction(ClusterService clusterService,
 TransportService transportService,
 IndicesService indicesService,
 ActionFilters actionFilters,
 IndexNameExpressionResolver indexNameExpressionResolver)

Method Details

shards

protected ShardsIterator shards(ClusterState clusterState,
 IndicesStatsRequest request,
 String[] concreteIndices)

Status goes across *all* shards.

Specified by:

shards in class TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

Parameters:

clusterState - the cluster state

request - the underlying request

concreteIndices - the concrete indices on which to execute the operation

Returns:

the shards on which to execute the operation

checkGlobalBlock

protected ClusterBlockException checkGlobalBlock(ClusterState state,
 IndicesStatsRequest request)

Description copied from class: TransportBroadcastByNodeAction

Executes a global block check before polling the cluster state.

Specified by:

checkGlobalBlock in class TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

Parameters:

state - the cluster state

request - the underlying request

Returns:

a non-null exception if the operation is blocked

checkRequestBlock

protected ClusterBlockException checkRequestBlock(ClusterState state,
 IndicesStatsRequest request,
 String[] concreteIndices)

Description copied from class: TransportBroadcastByNodeAction

Executes a global request-level check before polling the cluster state.

Specified by:

checkRequestBlock in class TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

Parameters:

state - the cluster state

request - the underlying request

concreteIndices - the concrete indices on which to execute the operation

Returns:

a non-null exception if the operation if blocked

readShardResult

protected ShardStats readShardResult(org.opensearch.core.common.io.stream.StreamInput in)
                              throws IOException

Description copied from class: TransportBroadcastByNodeAction

Deserialize a shard-level result from an input stream

Specified by:

readShardResult in class TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

Parameters:

in - input stream

Returns:

a deserialized shard-level result

Throws:

IOException

newResponse

protected IndicesStatsResponse newResponse(IndicesStatsRequest request,
 int totalShards,
 int successfulShards,
 int failedShards,
 List<ShardStats> responses,
 List<org.opensearch.core.action.support.DefaultShardOperationFailedException> shardFailures,
 ClusterState clusterState)

Description copied from class: TransportBroadcastByNodeAction

Creates a new response to the underlying request.

Specified by:

newResponse in class TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

Parameters:

request - the underlying request

totalShards - the total number of shards considered for execution of the operation

successfulShards - the total number of shards for which execution of the operation was successful

failedShards - the total number of shards for which execution of the operation failed

responses - the per-node aggregated shard-level results

shardFailures - the exceptions corresponding to shard operation failures

clusterState - the cluster state

Returns:

the response

readRequestFrom

protected IndicesStatsRequest readRequestFrom(org.opensearch.core.common.io.stream.StreamInput in)
                                       throws IOException

Description copied from class: TransportBroadcastByNodeAction

Deserialize a request from an input stream

Specified by:

readRequestFrom in class TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

Parameters:

in - input stream

Returns:

a de-serialized request

Throws:

IOException

shardOperation

protected ShardStats shardOperation(IndicesStatsRequest request,
 ShardRouting shardRouting)

Description copied from class: TransportBroadcastByNodeAction

Executes the shard-level operation. This method is called once per shard serially on the receiving node.

Specified by:

shardOperation in class TransportBroadcastByNodeAction<IndicesStatsRequest,IndicesStatsResponse,ShardStats>

Parameters:

request - the node-level request

shardRouting - the shard on which to execute the operation

Returns:

the result of the shard-level operation for the shard