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:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class SearchResult extends com.ibm.cloud.sdk.core.service.model.GenericModel
Schema for the result of a query search operation.
-
-
Constructor Summary
Constructors Constructor Description SearchResult()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.
-
-
-
Method Detail
-
getTotalRows
public Long getTotalRows()
Gets the totalRows. Number of total rows.- 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
-
-