Package org.elasticsearch.index.reindex
Class ScrollableHitSource
org.elasticsearch.index.reindex.ScrollableHitSource
- Direct Known Subclasses:
ClientScrollableHitSource
public abstract class ScrollableHitSource
extends
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).
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static class
An implementation of ScrollableHitSource.Hit that uses getters and setters.static interface
A document returned as part of the response.static class
Response from each scroll batch.static class
A failure during search. -
Field Summary
Modifier and TypeFieldDescriptionprotected BackoffPolicy
protected
protected <>
protected org.apache.logging.log4j.Logger
protected ThreadPool
-
Constructor Summary
ConstructorDescriptionScrollableHitSource(org.apache.logging.log4j.Logger logger, BackoffPolicy backoffPolicy, ThreadPool threadPool, countSearchRetry, <ScrollableHitSource.AsyncResponse> onResponse, <> fail)
-
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
onCompletion)
Called after the process has been totally finished to clean up any resources the process needed like remote connections.protected abstract void
scrollId, onCompletion)
Called to clear a scroll id.void
onCompletion)
protected abstract void
doStart(RejectAwareActionListener<ScrollableHitSource.Response> searchListener)
protected abstract void
scrollId, org.elasticsearch.core.TimeValue extraKeepAlive, RejectAwareActionListener<ScrollableHitSource.Response> searchListener)
void
scrollId)
Set the id of the last scroll.void
start()
Methods inherited from class java.lang.
, , , , , , , , , ,
-
Field Details
-
logger
protected final org.apache.logging.log4j.Logger logger -
backoffPolicy
-
threadPool
-
countSearchRetry
protected final countSearchRetry -
fail
protected final <> fail
-
-
Constructor Details
-
ScrollableHitSource
public ScrollableHitSource(org.apache.logging.log4j.Logger logger, BackoffPolicy backoffPolicy, ThreadPool threadPool, countSearchRetry, <ScrollableHitSource.AsyncResponse> onResponse, <> fail)
-
-
Method Details
-
start
public final void start() -
close
public final void close( onCompletion) -
doStart
protected abstract void doStart(RejectAwareActionListener<ScrollableHitSource.Response> searchListener) -
doStartNextScroll
protected abstract void doStartNextScroll( scrollId, org.elasticsearch.core.TimeValue extraKeepAlive, RejectAwareActionListener<ScrollableHitSource.Response> searchListener) -
clearScroll
protected abstract void clearScroll( scrollId, 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( 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( scrollId)Set the id of the last scroll. Used for debugging.
-