Package org.opensearch.gateway

Class GatewayAllocator

java.lang.Object

org.opensearch.gateway.GatewayAllocator

All Implemented Interfaces:

ExistingShardsAllocator

public class GatewayAllocator
extends java.lang.Object
implements ExistingShardsAllocator

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator

ExistingShardsAllocator.UnassignedAllocationHandler

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALLOCATOR_NAME

Fields inherited from interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator

EXISTING_SHARDS_ALLOCATOR_SETTING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GatewayAllocator()
	GatewayAllocator(RerouteService rerouteService, TransportNodesListGatewayStartedShards startedAction, TransportNodesListShardStoreMetadata storeAction)

Method Summary

Modifier and Type	Method	Description
void	afterPrimariesBeforeReplicas(RoutingAllocation allocation)	Called during a round of allocation after attempting to allocate all the primaries but before any replicas, allowing the allocator to prepare for replica allocation.
void	allocateUnassigned(ShardRouting shardRouting, RoutingAllocation allocation, ExistingShardsAllocator.UnassignedAllocationHandler unassignedAllocationHandler)	Allocate any unassigned shards in the given RoutingAllocation for which this ExistingShardsAllocator is responsible.
void	applyFailedShards(java.util.List<FailedShard> failedShards, RoutingAllocation allocation)	Called when the given shards have failed, so that implementations can invalidate caches and clean up any in-flight activity for those shards.
void	applyStartedShards(java.util.List<ShardRouting> startedShards, RoutingAllocation allocation)	Called when the given shards have started, so that implementations can invalidate caches and clean up any in-flight activity for those shards.
void	beforeAllocation(RoutingAllocation allocation)	Called before starting a round of allocation, allowing the allocator to invalidate some caches if appropriate.
void	cleanCaches()	Called when this node becomes the elected master and when it stops being the elected master, so that implementations can clean up any in-flight activity from an earlier mastership.
AllocateUnassignedDecision	explainUnassignedShardAllocation(ShardRouting unassignedShard, RoutingAllocation routingAllocation)	Returns an explanation for a single unassigned shard.
int	getNumberOfInFlightFetches()
protected static void	innerAllocatedUnassigned(RoutingAllocation allocation, PrimaryShardAllocator primaryShardAllocator, ReplicaShardAllocator replicaShardAllocator, ShardRouting shardRouting, ExistingShardsAllocator.UnassignedAllocationHandler unassignedAllocationHandler)

Methods inherited from class java.lang.Object

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

Field Details

ALLOCATOR_NAME

public static final java.lang.String ALLOCATOR_NAME

See Also:

Constant Field Values

Constructor Details

GatewayAllocator

@Inject public GatewayAllocator(RerouteService rerouteService, TransportNodesListGatewayStartedShards startedAction, TransportNodesListShardStoreMetadata storeAction)

GatewayAllocator

protected GatewayAllocator()

Method Details

cleanCaches

public void cleanCaches()

Description copied from interface: ExistingShardsAllocator

Called when this node becomes the elected master and when it stops being the elected master, so that implementations can clean up any in-flight activity from an earlier mastership.

Specified by:

cleanCaches in interface ExistingShardsAllocator

getNumberOfInFlightFetches

public int getNumberOfInFlightFetches()

Specified by:

getNumberOfInFlightFetches in interface ExistingShardsAllocator

Returns:

the number of in-flight fetches under this allocator's control.

applyStartedShards

public void applyStartedShards(java.util.List<ShardRouting> startedShards, RoutingAllocation allocation)

Description copied from interface: ExistingShardsAllocator

Called when the given shards have started, so that implementations can invalidate caches and clean up any in-flight activity for those shards.

Specified by:

applyStartedShards in interface ExistingShardsAllocator

applyFailedShards

public void applyFailedShards(java.util.List<FailedShard> failedShards, RoutingAllocation allocation)

Description copied from interface: ExistingShardsAllocator

Called when the given shards have failed, so that implementations can invalidate caches and clean up any in-flight activity for those shards.

Specified by:

applyFailedShards in interface ExistingShardsAllocator

beforeAllocation

public void beforeAllocation(RoutingAllocation allocation)

Description copied from interface: ExistingShardsAllocator

Called before starting a round of allocation, allowing the allocator to invalidate some caches if appropriate.

Specified by:

beforeAllocation in interface ExistingShardsAllocator

afterPrimariesBeforeReplicas

public void afterPrimariesBeforeReplicas(RoutingAllocation allocation)

Description copied from interface: ExistingShardsAllocator

Called during a round of allocation after attempting to allocate all the primaries but before any replicas, allowing the allocator to prepare for replica allocation.

Specified by:

afterPrimariesBeforeReplicas in interface ExistingShardsAllocator

allocateUnassigned

public void allocateUnassigned(ShardRouting shardRouting, RoutingAllocation allocation, ExistingShardsAllocator.UnassignedAllocationHandler unassignedAllocationHandler)

Description copied from interface: ExistingShardsAllocator

Allocate any unassigned shards in the given RoutingAllocation for which this ExistingShardsAllocator is responsible.

Specified by:

allocateUnassigned in interface ExistingShardsAllocator

innerAllocatedUnassigned

protected static void innerAllocatedUnassigned(RoutingAllocation allocation, PrimaryShardAllocator primaryShardAllocator, ReplicaShardAllocator replicaShardAllocator, ShardRouting shardRouting, ExistingShardsAllocator.UnassignedAllocationHandler unassignedAllocationHandler)

explainUnassignedShardAllocation

public AllocateUnassignedDecision explainUnassignedShardAllocation(ShardRouting unassignedShard, RoutingAllocation routingAllocation)

Description copied from interface: ExistingShardsAllocator

Returns an explanation for a single unassigned shard.

Specified by:

explainUnassignedShardAllocation in interface ExistingShardsAllocator