Package org.opensearch.cluster.routing

Class RoutingNodes.UnassignedShards.UnassignedIterator

java.lang.Object

org.opensearch.cluster.routing.RoutingNodes.UnassignedShards.UnassignedIterator

All Implemented Interfaces:

Iterator<ShardRouting>, ExistingShardsAllocator.UnassignedAllocationHandler

Enclosing class:

RoutingNodes.UnassignedShards

@PublicApi(since="1.0.0")
public class RoutingNodes.UnassignedShards.UnassignedIterator
extends Object
implements Iterator<ShardRouting>, ExistingShardsAllocator.UnassignedAllocationHandler

An unassigned iterator.

Opensearch.api:

Constructor Summary

Constructors

Constructor	Description
UnassignedIterator()

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()
ShardRouting	initialize(String nodeId, String existingAllocationId, long expectedShardSize, RoutingChangesObserver routingChangesObserver)	Initializes the current unassigned shard and moves it from the unassigned list.
ShardRouting	next()
void	remove()	Unsupported operation, just there for the interface.
void	removeAndIgnore(UnassignedInfo.AllocationStatus attempt, RoutingChangesObserver changes)	Removes and ignores the unassigned shard (will be ignored for this run, but will be added back to unassigned once the metadata is constructed again).
ShardRouting	updateUnassigned(UnassignedInfo unassignedInfo, RecoverySource recoverySource, RoutingChangesObserver changes)	updates the unassigned info and recovery source on the current unassigned shard

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

UnassignedIterator

public UnassignedIterator()

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<ShardRouting>

next

public ShardRouting next()

Specified by:

next in interface Iterator<ShardRouting>

initialize

public ShardRouting initialize(String nodeId,
 @Nullable
 String existingAllocationId,
 long expectedShardSize,
 RoutingChangesObserver routingChangesObserver)

Initializes the current unassigned shard and moves it from the unassigned list.

Specified by:

initialize in interface ExistingShardsAllocator.UnassignedAllocationHandler

Parameters:

existingAllocationId - allocation id to use. If null, a fresh allocation id is generated.

removeAndIgnore

public void removeAndIgnore(UnassignedInfo.AllocationStatus attempt,
 RoutingChangesObserver changes)

Removes and ignores the unassigned shard (will be ignored for this run, but will be added back to unassigned once the metadata is constructed again). Typically this is used when an allocation decision prevents a shard from being allocated such that subsequent consumers of this API won't try to allocate this shard again.

Specified by:

removeAndIgnore in interface ExistingShardsAllocator.UnassignedAllocationHandler

Parameters:

attempt - the result of the allocation attempt

updateUnassigned

public ShardRouting updateUnassigned(UnassignedInfo unassignedInfo,
 RecoverySource recoverySource,
 RoutingChangesObserver changes)

updates the unassigned info and recovery source on the current unassigned shard

Specified by:

updateUnassigned in interface ExistingShardsAllocator.UnassignedAllocationHandler

Parameters:

unassignedInfo - the new unassigned info to use

recoverySource - the new recovery source to use

Returns:

the shard with unassigned info updated

remove

public void remove()

Unsupported operation, just there for the interface. Use removeAndIgnore(AllocationStatus, RoutingChangesObserver) or initialize(String, String, long, RoutingChangesObserver).

Specified by:

remove in interface Iterator<ShardRouting>