Package org.elasticsearch.index.reindex
Class ScrollableHitSource
- java.lang.Object
-
- org.elasticsearch.index.reindex.ScrollableHitSource
-
- Direct Known Subclasses:
ClientScrollableHitSource
public abstract class ScrollableHitSource extends java.lang.Object
A scrollable source of results.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description 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 BackoffPolicy
backoffPolicy
protected java.lang.Runnable
countSearchRetry
protected java.util.function.Consumer<java.lang.Exception>
fail
protected org.apache.logging.log4j.Logger
logger
protected ThreadPool
threadPool
-
Constructor Summary
Constructors Constructor Description ScrollableHitSource(org.apache.logging.log4j.Logger logger, BackoffPolicy backoffPolicy, ThreadPool threadPool, java.lang.Runnable countSearchRetry, java.util.function.Consumer<java.lang.Exception> fail)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract void
cleanup(java.lang.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(java.lang.String scrollId, java.lang.Runnable onCompletion)
Called to clear a scroll id.void
close(java.lang.Runnable onCompletion)
protected abstract void
doStart(java.util.function.Consumer<? super ScrollableHitSource.Response> onResponse)
protected abstract void
doStartNextScroll(java.lang.String scrollId, TimeValue extraKeepAlive, java.util.function.Consumer<? super ScrollableHitSource.Response> onResponse)
void
setScroll(java.lang.String scrollId)
Set the id of the last scroll.void
start(java.util.function.Consumer<ScrollableHitSource.Response> onResponse)
void
startNextScroll(TimeValue extraKeepAlive, java.util.function.Consumer<ScrollableHitSource.Response> onResponse)
-
-
-
Field Detail
-
logger
protected final org.apache.logging.log4j.Logger logger
-
backoffPolicy
protected final BackoffPolicy backoffPolicy
-
threadPool
protected final ThreadPool threadPool
-
countSearchRetry
protected final java.lang.Runnable countSearchRetry
-
fail
protected final java.util.function.Consumer<java.lang.Exception> fail
-
-
Constructor Detail
-
ScrollableHitSource
public ScrollableHitSource(org.apache.logging.log4j.Logger logger, BackoffPolicy backoffPolicy, ThreadPool threadPool, java.lang.Runnable countSearchRetry, java.util.function.Consumer<java.lang.Exception> fail)
-
-
Method Detail
-
start
public final void start(java.util.function.Consumer<ScrollableHitSource.Response> onResponse)
-
doStart
protected abstract void doStart(java.util.function.Consumer<? super ScrollableHitSource.Response> onResponse)
-
startNextScroll
public final void startNextScroll(TimeValue extraKeepAlive, java.util.function.Consumer<ScrollableHitSource.Response> onResponse)
-
doStartNextScroll
protected abstract void doStartNextScroll(java.lang.String scrollId, TimeValue extraKeepAlive, java.util.function.Consumer<? super ScrollableHitSource.Response> onResponse)
-
close
public final void close(java.lang.Runnable onCompletion)
-
clearScroll
protected abstract void clearScroll(java.lang.String scrollId, java.lang.Runnable onCompletion)
Called to clear a scroll id.- Parameters:
scrollId
- the id to clearonCompletion
- implementers must call this after completing the clear whether they are successful or not
-
cleanup
protected abstract void cleanup(java.lang.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(java.lang.String scrollId)
Set the id of the last scroll. Used for debugging.
-
-