Interface AsyncSearchQueryResult
- All Known Implementing Classes:
DefaultAsyncSearchQueryResult
@Committed @Public public interface AsyncSearchQueryResult
The asynchronous interface for FTS query results.
- Since:
- 2.3.0
- Author:
- Simon Baslé, Michael Nitschinger
-
Method Summary
Modifier and Type Method Description rx.Observable<FacetResult>
facets()
AnObservable
emitting aFacetResult
for each requested facet in the original request.rx.Observable<SearchQueryRow>
hits()
AnObservable
ofrows
(or hits) describing each individual result.rx.Observable<SearchMetrics>
metrics()
AnObservable
asynchronously providing statistics about the request in the form of a singleSearchMetrics
.SearchStatus
status()
TheSearchStatus
allows to check if the request was a full success (SearchStatus.isSuccess()
) and gives more details about status for each queried index.
-
Method Details
-
status
SearchStatus status()TheSearchStatus
allows to check if the request was a full success (SearchStatus.isSuccess()
) and gives more details about status for each queried index. -
hits
rx.Observable<SearchQueryRow> hits()AnObservable
ofrows
(or hits) describing each individual result. Note that in case of a partial success,Observer.onError(Throwable)
will be called after each partial result has been emitted. In case of a full execution failure, no hit is emitted before the onError. The following execution-level exceptions can happen: - if there is one or more execution-level errors, each of them is represented as aRuntimeException
, and all are aggregated into a singleCompositeException
. - if the request is malformed, the server side error message is returned as the message of aCouchbaseException
. -
facets
rx.Observable<FacetResult> facets()AnObservable
emitting aFacetResult
for each requested facet in the original request. -
metrics
rx.Observable<SearchMetrics> metrics()AnObservable
asynchronously providing statistics about the request in the form of a singleSearchMetrics
. Note that the metrics are emitted after all hits have been received.
-