Package org.elasticsearch.index.reindex

Class ScrollableHitSource.Response

java.lang.Object

org.elasticsearch.index.reindex.ScrollableHitSource.Response

Enclosing class:

ScrollableHitSource

public static class ScrollableHitSource.Response
extends Object

Response from each scroll batch.

Constructor Summary

Constructors

Constructor	Description
Response(boolean timedOut, List<ScrollableHitSource.SearchFailure> failures, long totalHits, List<? extends ScrollableHitSource.Hit> hits, String scrollId)

Method Summary

Modifier and Type	Method	Description
final List<ScrollableHitSource.SearchFailure>	getFailures()	Where there any search failures?
List<? extends ScrollableHitSource.Hit>	getHits()	The documents returned in this batch.
String	getScrollId()	The scroll id used to fetch the next set of documents.
long	getTotalHits()	What were the total number of documents matching the search?
boolean	isTimedOut()	Did this batch time out?

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response(boolean timedOut,
 List<ScrollableHitSource.SearchFailure> failures,
 long totalHits,
 List<? extends ScrollableHitSource.Hit> hits,
 String scrollId)

Method Details

isTimedOut

public boolean isTimedOut()

Did this batch time out?

getFailures

public final List<ScrollableHitSource.SearchFailure> getFailures()

Where there any search failures?

getTotalHits

public long getTotalHits()

What were the total number of documents matching the search?

getHits

public List<? extends ScrollableHitSource.Hit> getHits()

The documents returned in this batch.

getScrollId

public String getScrollId()

The scroll id used to fetch the next set of documents.