Package org.nuxeo.elasticsearch.api

Class EsScrollResult

java.lang.Object

org.nuxeo.elasticsearch.api.EsResult

org.nuxeo.elasticsearch.api.EsScrollResult

public class EsScrollResult
extends EsResult

Wrapper for the results of a scrollable search request.

Since:

8.3

See Also:

• ElasticSearchService.scroll(NxQueryBuilder, long)
• ElasticSearchService.scroll(EsScrollResult)

Field Summary

Fields

Modifier and Type	Field	Description
protected final long	keepAlive	Timeout for keeping the search context alive.
protected final NxQueryBuilder	queryBuilder	NxQueryBuilder used for the initial search request.
protected final String	scrollId	Scroll id returned by the search request.

Constructor Summary

Constructors

Constructor	Description
EsScrollResult(DocumentModelList documents, org.opensearch.action.search.SearchResponse response, NxQueryBuilder queryBuilder, String scrollId, long keepAlive)
EsScrollResult(IterableQueryResult rows, org.opensearch.action.search.SearchResponse response, NxQueryBuilder queryBuilder, String scrollId, long keepAlive)
EsScrollResult(NxQueryBuilder queryBuilder, String scrollId, long keepAlive)
EsScrollResult(org.opensearch.action.search.SearchResponse response, NxQueryBuilder queryBuilder, String scrollId, long keepAlive)

Method Summary

Modifier and Type	Method	Description
long	getKeepAlive()
NxQueryBuilder	getQueryBuilder()
String	getScrollId()

Methods inherited from class org.nuxeo.elasticsearch.api.EsResult

getAggregates, getDocuments, getElasticsearchResponse, getRows

Methods inherited from class java.lang.Object

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

Field Details

queryBuilder

protected final NxQueryBuilder queryBuilder

NxQueryBuilder used for the initial search request.

scrollId

protected final String scrollId

Scroll id returned by the search request.

keepAlive

protected final long keepAlive

Timeout for keeping the search context alive.

Constructor Details

EsScrollResult

public EsScrollResult(DocumentModelList documents,
 org.opensearch.action.search.SearchResponse response,
 NxQueryBuilder queryBuilder,
 String scrollId,
 long keepAlive)

EsScrollResult

public EsScrollResult(IterableQueryResult rows,
 org.opensearch.action.search.SearchResponse response,
 NxQueryBuilder queryBuilder,
 String scrollId,
 long keepAlive)

EsScrollResult

public EsScrollResult(org.opensearch.action.search.SearchResponse response,
 NxQueryBuilder queryBuilder,
 String scrollId,
 long keepAlive)

EsScrollResult

public EsScrollResult(NxQueryBuilder queryBuilder,
 String scrollId,
 long keepAlive)

Method Details

getQueryBuilder

public NxQueryBuilder getQueryBuilder()

getScrollId

public String getScrollId()

getKeepAlive

public long getKeepAlive()