Package com.couchbase.client.java.search.result

Class SearchResult

java.lang.Object

com.couchbase.client.java.search.result.SearchResult

public class SearchResult
extends Object

The result of an search query, including hits and associated metadata.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
SearchResult(List<SearchRow> rows, Map<String,SearchFacetResult> facets, SearchMetaData meta)	Creates a new SearchResult.

Method Summary

Modifier and Type	Method	Description
Map<String,SearchFacetResult>	facets()	Returns the facets if present in this query.
SearchMetaData	metaData()	Returns the SearchMetaData giving access to the additional metadata associated with this search query.
List<SearchRow>	rows()	Returns all search hits.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResult

public SearchResult(List<SearchRow> rows,
Map<String,SearchFacetResult> facets,
SearchMetaData meta)

Creates a new SearchResult.

Parameters:

rows - the rows/hits for this result.

meta - the search metadata.

Method Details

metaData

public SearchMetaData metaData()

Returns the SearchMetaData giving access to the additional metadata associated with this search query.

rows

public List<SearchRow> rows()

Returns all search hits.

facets

public Map<String,SearchFacetResult> facets()

Returns the facets if present in this query.

toString

public String toString()

Overrides:

toString in class Object