org.elasticsearch.action.bulk.byscroll

Class ScrollableHitSource

java.lang.Object

org.elasticsearch.action.bulk.byscroll.ScrollableHitSource

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

ClientScrollableHitSource

public abstract class ScrollableHitSource
extends java.lang.Object
implements java.io.Closeable

A scrollable source of results.

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 and 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 and 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

Modifier and Type	Method and Description
protected abstract void	cleanup() 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()
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	start(java.util.function.Consumer<ScrollableHitSource.Response> onResponse)
void	startNextScroll(TimeValue extraKeepAlive, java.util.function.Consumer<ScrollableHitSource.Response> onResponse)

Methods inherited from class java.lang.Object

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

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()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

clearScroll

protected abstract void clearScroll(java.lang.String scrollId,
                                    java.lang.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()

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