Package org.nuxeo.elasticsearch.api

Class EsResult

java.lang.Object

org.nuxeo.elasticsearch.api.EsResult

Direct Known Subclasses:

EsScrollResult

public class EsResult
extends Object

Since:

6.0

Constructor Summary

Constructors

Constructor	Description
EsResult(DocumentModelList documents, List<Aggregate<Bucket>> aggregates, org.opensearch.action.search.SearchResponse response)
EsResult(IterableQueryResult rows, List<Aggregate<Bucket>> aggregates, org.opensearch.action.search.SearchResponse response)
EsResult(org.opensearch.action.search.SearchResponse response)

Method Summary

Modifier and Type	Method	Description
List<Aggregate<Bucket>>	getAggregates()	Get the aggregates list or null if onlyElasticsearchResponse option is set.
DocumentModelList	getDocuments()	Get the list of Nuxeo documents, this is populated when using a SELECT * clause, or when submitting esQuery.
org.opensearch.action.search.SearchResponse	getElasticsearchResponse()	Returns the original Elasticsearch response.
IterableQueryResult	getRows()	Iterator to use when selecting fields: SELECT ecm:uuid ...

Methods inherited from class java.lang.Object

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

Constructor Details

EsResult

public EsResult(DocumentModelList documents,
 List<Aggregate<Bucket>> aggregates,
 org.opensearch.action.search.SearchResponse response)

EsResult

public EsResult(IterableQueryResult rows,
 List<Aggregate<Bucket>> aggregates,
 org.opensearch.action.search.SearchResponse response)

EsResult

public EsResult(org.opensearch.action.search.SearchResponse response)

Method Details

getDocuments

public DocumentModelList getDocuments()

Get the list of Nuxeo documents, this is populated when using a SELECT * clause, or when submitting esQuery.

Returns:

null if the query returns fields or if the onlyElasticsearchResponse option is set.

getRows

public IterableQueryResult getRows()

Iterator to use when selecting fields: SELECT ecm:uuid ...

Returns:

null if the query returns documents or if the onlyElasticsearchResponse option is set.

Since:

7.2

getAggregates

public List<Aggregate<Bucket>> getAggregates()

Get the aggregates list or null if onlyElasticsearchResponse option is set.

getElasticsearchResponse

public org.opensearch.action.search.SearchResponse getElasticsearchResponse()

Returns the original Elasticsearch response. Use it at your own risk

Since:

7.3