Package org.opensearch.index.reindex

Class ScrollableHitSource

java.lang.Object

org.opensearch.index.reindex.ScrollableHitSource

Direct Known Subclasses:

ClientScrollableHitSource

public abstract class ScrollableHitSource
extends Object

A scrollable source of results. Pumps data out into the passed onResponse consumer. Same data may come out several times in case of failures during searching (though not yet). Once the onResponse consumer is done, it should call AsyncResponse.isDone(time) to receive more data (only receives one response at a time).

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScrollableHitSource.AsyncResponse	Asynchronous response
static class	ScrollableHitSource.BasicHit	An implementation of ScrollableHitSource.Hit that uses getters and setters.
static interface	ScrollableHitSource.Hit	A document returned as part of the response.
static class	ScrollableHitSource.Response	Response from each scroll batch.
static class	ScrollableHitSource.SearchFailure	A failure during search.

Field Summary

Fields

Modifier and Type	Field	Description
protected final BackoffPolicy	backoffPolicy
protected final Runnable	countSearchRetry
protected final Consumer<Exception>	fail
protected final org.apache.logging.log4j.Logger	logger
protected final ThreadPool	threadPool

Constructor Summary

Constructors

Constructor	Description
ScrollableHitSource(org.apache.logging.log4j.Logger logger, BackoffPolicy backoffPolicy, ThreadPool threadPool, Runnable countSearchRetry, Consumer<ScrollableHitSource.AsyncResponse> onResponse, Consumer<Exception> fail)

Method Summary

Modifier and Type	Method	Description
protected abstract void	cleanup(Runnable onCompletion)	Called after the process has been totally finished to clean up any resources the process needed like remote connections.
protected abstract void	clearScroll(String scrollId, Runnable onCompletion)	Called to clear a scroll id.
final void	close(Runnable onCompletion)
protected abstract void	doStart(RejectAwareActionListener<ScrollableHitSource.Response> searchListener)
protected abstract void	doStartNextScroll(String scrollId, org.opensearch.common.unit.TimeValue extraKeepAlive, RejectAwareActionListener<ScrollableHitSource.Response> searchListener)
final void	setScroll(String scrollId)	Set the id of the last scroll.
final void	start()

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.apache.logging.log4j.Logger logger

backoffPolicy

protected final BackoffPolicy backoffPolicy

threadPool

protected final ThreadPool threadPool

countSearchRetry

protected final Runnable countSearchRetry

fail

protected final Consumer<Exception> fail

Constructor Details

ScrollableHitSource

public ScrollableHitSource(org.apache.logging.log4j.Logger logger,
 BackoffPolicy backoffPolicy,
 ThreadPool threadPool,
 Runnable countSearchRetry,
 Consumer<ScrollableHitSource.AsyncResponse> onResponse,
 Consumer<Exception> fail)

Method Details

start

public final void start()

close

public final void close(Runnable onCompletion)

doStart

protected abstract void doStart(RejectAwareActionListener<ScrollableHitSource.Response> searchListener)

doStartNextScroll

protected abstract void doStartNextScroll(String scrollId,
 org.opensearch.common.unit.TimeValue extraKeepAlive,
 RejectAwareActionListener<ScrollableHitSource.Response> searchListener)

clearScroll

protected abstract void clearScroll(String scrollId,
 Runnable onCompletion)

Called to clear a scroll id.

Parameters:

scrollId - the id to clear

onCompletion - implementers must call this after completing the clear whether they are successful or not

cleanup

protected abstract void cleanup(Runnable onCompletion)

Called after the process has been totally finished to clean up any resources the process needed like remote connections.

Parameters:

onCompletion - implementers must call this after completing the cleanup whether they are successful or not

setScroll

public final void setScroll(String scrollId)

Set the id of the last scroll. Used for debugging.