com.couchbase.client.java.search.result

Interface AsyncSearchQueryResult

All Known Implementing Classes:

DefaultAsyncSearchQueryResult

@InterfaceStability.Experimental
 @InterfaceAudience.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 and Description
Observable<FacetResult>	facets() An Observable emitting a FacetResult for each requested facet in the original request.
Observable<SearchQueryRow>	hits() An Observable of rows (or hits) describing each individual result.
Observable<SearchMetrics>	metrics() An Observable asynchronously providing statistics about the request in the form of a single SearchMetrics.
SearchStatus	status() The SearchStatus allows to check if the request was a full success (SearchStatus.isSuccess()) and gives more details about status for each queried index.

Method Detail

status

SearchStatus status()

The SearchStatus allows to check if the request was a full success (SearchStatus.isSuccess()) and gives more details about status for each queried index.

hits

Observable<SearchQueryRow> hits()

An Observable of rows (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 a RuntimeException, and all are aggregated into a single CompositeException.
• if the request is malformed, the server side error message is returned as the message of a CouchbaseException.

facets

Observable<FacetResult> facets()

An Observable emitting a FacetResult for each requested facet in the original request.

metrics

Observable<SearchMetrics> metrics()

An Observable asynchronously providing statistics about the request in the form of a single SearchMetrics. Note that the metrics are emitted after all hits have been received.