Package org.elasticsearch.action.support

Class ActiveShardsObserver

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.action.support.ActiveShardsObserver

public class ActiveShardsObserver
extends AbstractComponent

This class provides primitives for waiting for a configured number of shards to become active before sending a response on an ActionListener.

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor	Description
ActiveShardsObserver(Settings settings, ClusterService clusterService, ThreadPool threadPool)

Method Summary

Modifier and Type	Method	Description
void	waitForActiveShards(java.lang.String[] indexNames, ActiveShardCount activeShardCount, TimeValue timeout, java.util.function.Consumer<java.lang.Boolean> onResult, java.util.function.Consumer<java.lang.Exception> onFailure)	Waits on the specified number of active shards to be started before executing the

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveShardsObserver

public ActiveShardsObserver(Settings settings,
                            ClusterService clusterService,
                            ThreadPool threadPool)

Method Detail

waitForActiveShards

public void waitForActiveShards(java.lang.String[] indexNames,
                                ActiveShardCount activeShardCount,
                                TimeValue timeout,
                                java.util.function.Consumer<java.lang.Boolean> onResult,
                                java.util.function.Consumer<java.lang.Exception> onFailure)

Waits on the specified number of active shards to be started before executing the

Parameters:

indexNames - the indices to wait for active shards on

activeShardCount - the number of active shards to wait on before returning

timeout - the timeout value

onResult - a function that is executed in response to the requisite shards becoming active or a timeout (whichever comes first)

onFailure - a function that is executed in response to an error occurring during waiting for the active shards