Package org.opensearch.gateway

Class TransportNodesListGatewayStartedShards

java.lang.Object

org.opensearch.action.support.TransportAction<TransportNodesListGatewayStartedShards.Request,TransportNodesListGatewayStartedShards.NodesGatewayStartedShards>

org.opensearch.action.support.HandledTransportAction<TransportNodesListGatewayStartedShards.Request,TransportNodesListGatewayStartedShards.NodesGatewayStartedShards>

org.opensearch.action.support.nodes.TransportNodesAction<TransportNodesListGatewayStartedShards.Request,TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeRequest,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>

org.opensearch.gateway.TransportNodesListGatewayStartedShards

All Implemented Interfaces:

AsyncShardFetch.Lister<TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>

public class TransportNodesListGatewayStartedShards
extends TransportNodesAction<TransportNodesListGatewayStartedShards.Request,TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeRequest,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>
implements AsyncShardFetch.Lister<TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>

This transport action is used to fetch the shard version from each node during primary allocation in GatewayAllocator. We use this to find out which node holds the latest shard version and which of them used to be a primary in order to allocate shards after node or cluster restarts.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransportNodesListGatewayStartedShards.NodeGatewayStartedShards	The response.
static class	TransportNodesListGatewayStartedShards.NodeRequest	The request.
static class	TransportNodesListGatewayStartedShards.NodesGatewayStartedShards	The nodes response.
static class	TransportNodesListGatewayStartedShards.Request	The nodes request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_NAME
static final ActionType<TransportNodesListGatewayStartedShards.NodesGatewayStartedShards>	TYPE

Fields inherited from class org.opensearch.action.support.nodes.TransportNodesAction

clusterService, nodeResponseClass, threadPool, transportNodeAction, transportService

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

actionName, logger, taskManager

Constructor Summary

Constructors

Constructor	Description
TransportNodesListGatewayStartedShards(Settings settings, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, NodeEnvironment env, IndicesService indicesService, org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry)

Method Summary

Modifier and Type	Method	Description
void	list(Map<org.opensearch.core.index.shard.ShardId,ShardAttributes> shardAttributesMap, DiscoveryNode[] nodes, org.opensearch.core.action.ActionListener<TransportNodesListGatewayStartedShards.NodesGatewayStartedShards> listener)
protected TransportNodesListGatewayStartedShards.NodeRequest	newNodeRequest(TransportNodesListGatewayStartedShards.Request request)
protected TransportNodesListGatewayStartedShards.NodeGatewayStartedShards	newNodeResponse(org.opensearch.core.common.io.stream.StreamInput in)
protected TransportNodesListGatewayStartedShards.NodesGatewayStartedShards	newResponse(TransportNodesListGatewayStartedShards.Request request, List<TransportNodesListGatewayStartedShards.NodeGatewayStartedShards> responses, List<FailedNodeException> failures)	Create a new TransportNodesAction (multi-node response).
protected TransportNodesListGatewayStartedShards.NodeGatewayStartedShards	nodeOperation(TransportNodesListGatewayStartedShards.NodeRequest request)

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

doExecute, getTransportNodeAction, newResponse, nodeOperation, resolveRequest

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

Field Details

ACTION_NAME

public static final String ACTION_NAME

See Also:

• Constant Field Values

TYPE

public static final ActionType<TransportNodesListGatewayStartedShards.NodesGatewayStartedShards> TYPE

Constructor Details

TransportNodesListGatewayStartedShards

@Inject
public TransportNodesListGatewayStartedShards(Settings settings,
 ThreadPool threadPool,
 ClusterService clusterService,
 TransportService transportService,
 ActionFilters actionFilters,
 NodeEnvironment env,
 IndicesService indicesService,
 org.opensearch.core.xcontent.NamedXContentRegistry namedXContentRegistry)

Method Details

list

public void list(Map<org.opensearch.core.index.shard.ShardId,ShardAttributes> shardAttributesMap,
 DiscoveryNode[] nodes,
 org.opensearch.core.action.ActionListener<TransportNodesListGatewayStartedShards.NodesGatewayStartedShards> listener)

Specified by:

list in interface AsyncShardFetch.Lister<TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>

newNodeRequest

protected TransportNodesListGatewayStartedShards.NodeRequest newNodeRequest(TransportNodesListGatewayStartedShards.Request request)

Specified by:

newNodeRequest in class TransportNodesAction<TransportNodesListGatewayStartedShards.Request,TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeRequest,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>

newNodeResponse

protected TransportNodesListGatewayStartedShards.NodeGatewayStartedShards newNodeResponse(org.opensearch.core.common.io.stream.StreamInput in)
                                                                                   throws IOException

Specified by:

newNodeResponse in class TransportNodesAction<TransportNodesListGatewayStartedShards.Request,TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeRequest,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>

Throws:

IOException

newResponse

protected TransportNodesListGatewayStartedShards.NodesGatewayStartedShards newResponse(TransportNodesListGatewayStartedShards.Request request,
 List<TransportNodesListGatewayStartedShards.NodeGatewayStartedShards> responses,
 List<FailedNodeException> failures)

Description copied from class: TransportNodesAction

Create a new TransportNodesAction (multi-node response).

Specified by:

newResponse in class TransportNodesAction<TransportNodesListGatewayStartedShards.Request,TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeRequest,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>

Parameters:

request - The associated request.

responses - All successful node-level responses.

failures - All node-level failures.

Returns:

Never null.

nodeOperation

protected TransportNodesListGatewayStartedShards.NodeGatewayStartedShards nodeOperation(TransportNodesListGatewayStartedShards.NodeRequest request)

Specified by:

nodeOperation in class TransportNodesAction<TransportNodesListGatewayStartedShards.Request,TransportNodesListGatewayStartedShards.NodesGatewayStartedShards,TransportNodesListGatewayStartedShards.NodeRequest,TransportNodesListGatewayStartedShards.NodeGatewayStartedShards>