Package com.ibm.cloud.cloudant.v1.model

Class SearchResult

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.cloudant.v1.model.SearchResult

All Implemented Interfaces:

ObjectModel

public class SearchResult
extends GenericModel

Schema for the result of a query search operation.

Method Summary

Modifier and Type	Method	Description
String	getBookmark()	Gets the bookmark.
String	getBy()	Gets the by.
Map<String,Map<String,Long>>	getCounts()	Gets the counts.
List<SearchResultProperties>	getGroups()	Gets the groups.
Map<String,Map<String,Long>>	getRanges()	Gets the ranges.
List<SearchResultRow>	getRows()	Gets the rows.
Long	getTotalRows()	Gets the totalRows.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

getTotalRows

public Long getTotalRows()

Gets the totalRows. Total number of rows in the index matching the search query. The limit may truncate the number of matches returned.

Returns:

the totalRows

getBookmark

public String getBookmark()

Gets the bookmark. Opaque bookmark token used when paginating results.

Returns:

the bookmark

getBy

public String getBy()

Gets the by. Grouped search matches.

Returns:

the by

getCounts

public Map<String,Map<String,Long>> getCounts()

Gets the counts. The counts facet syntax returns the number of query results for each unique value of each named field.

Returns:

the counts

getRanges

public Map<String,Map<String,Long>> getRanges()

Gets the ranges. The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit into each specified category.

Returns:

the ranges

getRows

public List<SearchResultRow> getRows()

Gets the rows. Array of row objects.

Returns:

the rows

getGroups

public List<SearchResultProperties> getGroups()

Gets the groups. Array of grouped search matches.

Returns:

the groups