org.elasticsearch.action.bulk.byscroll

Class ClientScrollableHitSource

java.lang.Object

org.elasticsearch.action.bulk.byscroll.ScrollableHitSource

org.elasticsearch.action.bulk.byscroll.ClientScrollableHitSource

public class ClientScrollableHitSource
extends ScrollableHitSource

A scrollable source of hits from a Client instance.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.bulk.byscroll.ScrollableHitSource

ScrollableHitSource.BasicHit, ScrollableHitSource.Hit, ScrollableHitSource.Response, ScrollableHitSource.SearchFailure

Field Summary

Fields inherited from class org.elasticsearch.action.bulk.byscroll.ScrollableHitSource

backoffPolicy, countSearchRetry, fail, logger, threadPool

Constructor Summary

Constructors

Constructor and Description
ClientScrollableHitSource(org.apache.logging.log4j.Logger logger, BackoffPolicy backoffPolicy, ThreadPool threadPool, java.lang.Runnable countSearchRetry, java.util.function.Consumer<java.lang.Exception> fail, ParentTaskAssigningClient client, SearchRequest firstSearchRequest)

Method Summary

Modifier and Type	Method and Description
protected 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.
void	clearScroll(java.lang.String scrollId, java.lang.Runnable onCompletion) Called to clear a scroll id.
void	doStart(java.util.function.Consumer<? super ScrollableHitSource.Response> onResponse)
protected void	doStartNextScroll(java.lang.String scrollId, TimeValue extraKeepAlive, java.util.function.Consumer<? super ScrollableHitSource.Response> onResponse)

Methods inherited from class org.elasticsearch.action.bulk.byscroll.ScrollableHitSource

close, start, startNextScroll

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientScrollableHitSource

public ClientScrollableHitSource(org.apache.logging.log4j.Logger logger,
                                 BackoffPolicy backoffPolicy,
                                 ThreadPool threadPool,
                                 java.lang.Runnable countSearchRetry,
                                 java.util.function.Consumer<java.lang.Exception> fail,
                                 ParentTaskAssigningClient client,
                                 SearchRequest firstSearchRequest)

Method Detail

doStart

public void doStart(java.util.function.Consumer<? super ScrollableHitSource.Response> onResponse)

Specified by:

doStart in class ScrollableHitSource

doStartNextScroll

protected void doStartNextScroll(java.lang.String scrollId,
                                 TimeValue extraKeepAlive,
                                 java.util.function.Consumer<? super ScrollableHitSource.Response> onResponse)

Specified by:

doStartNextScroll in class ScrollableHitSource

clearScroll

public void clearScroll(java.lang.String scrollId,
                        java.lang.Runnable onCompletion)

Description copied from class: ScrollableHitSource

Called to clear a scroll id.

Specified by:

clearScroll in class ScrollableHitSource

Parameters:

scrollId - the id to clear

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

cleanup

protected void cleanup(java.lang.Runnable onCompletion)

Description copied from class: ScrollableHitSource

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

Specified by:

cleanup in class ScrollableHitSource

Parameters:

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