Package org.opensearch.action.admin.cluster.tasks

Class TransportPendingClusterTasksAction

java.lang.Object

org.opensearch.action.support.TransportAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

org.opensearch.action.support.HandledTransportAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

org.opensearch.action.support.clustermanager.TransportClusterManagerNodeAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

org.opensearch.action.support.clustermanager.TransportClusterManagerNodeReadAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

org.opensearch.action.admin.cluster.tasks.TransportPendingClusterTasksAction

public class TransportPendingClusterTasksAction
extends TransportClusterManagerNodeReadAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

Transport action for getting pending cluster tasks

Opensearch.internal:

Field Summary

Fields inherited from class org.opensearch.action.support.clustermanager.TransportClusterManagerNodeReadAction

localExecuteSupported

Fields inherited from class org.opensearch.action.support.clustermanager.TransportClusterManagerNodeAction

indexNameExpressionResolver, threadPool, transportService

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

actionName, taskManager

Constructor Summary

Constructors

Constructor	Description
TransportPendingClusterTasksAction(TransportService transportService, ClusterService clusterService, ThreadPool threadPool, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver)

Method Summary

Modifier and Type	Method	Description
protected ClusterBlockException	checkBlock(PendingClusterTasksRequest request, ClusterState state)
protected void	clusterManagerOperation(PendingClusterTasksRequest request, ClusterState state, org.opensearch.core.action.ActionListener<PendingClusterTasksResponse> listener)
protected String	executor()
protected boolean	localExecuteSupportedByAction()	Override to true if the transport action can be executed locally and need NOT be executed always on cluster-manager (Read actions).
protected PendingClusterTasksResponse	read(org.opensearch.core.common.io.stream.StreamInput in)

Methods inherited from class org.opensearch.action.support.clustermanager.TransportClusterManagerNodeReadAction

localExecute

Methods inherited from class org.opensearch.action.support.clustermanager.TransportClusterManagerNodeAction

clusterManagerOperation, doExecute, getClusterManagerActionName, getMasterActionName, masterOperation, masterOperation

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

TransportPendingClusterTasksAction

@Inject
public TransportPendingClusterTasksAction(TransportService transportService,
 ClusterService clusterService,
 ThreadPool threadPool,
 ActionFilters actionFilters,
 IndexNameExpressionResolver indexNameExpressionResolver)

Method Details

executor

protected String executor()

Specified by:

executor in class TransportClusterManagerNodeAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

read

protected PendingClusterTasksResponse read(org.opensearch.core.common.io.stream.StreamInput in)
                                    throws IOException

Specified by:

read in class TransportClusterManagerNodeAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

Throws:

IOException

checkBlock

protected ClusterBlockException checkBlock(PendingClusterTasksRequest request,
 ClusterState state)

Specified by:

checkBlock in class TransportClusterManagerNodeAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

clusterManagerOperation

protected void clusterManagerOperation(PendingClusterTasksRequest request,
 ClusterState state,
 org.opensearch.core.action.ActionListener<PendingClusterTasksResponse> listener)

Overrides:

clusterManagerOperation in class TransportClusterManagerNodeAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

localExecuteSupportedByAction

protected boolean localExecuteSupportedByAction()

Description copied from class: TransportClusterManagerNodeAction

Override to true if the transport action can be executed locally and need NOT be executed always on cluster-manager (Read actions). The action is executed locally if this method returns true AND the ClusterState on local node is in-sync with ClusterManager.

Overrides:

localExecuteSupportedByAction in class TransportClusterManagerNodeReadAction<PendingClusterTasksRequest,PendingClusterTasksResponse>

Returns:

- boolean if the action can be run locally