Represents one page of search results, combining the total hit count, the requested page window and the matching SearchResult items. Extends AggBucketHolder so a caller can also attach aggregation buckets computed alongside the search, such as facet counts.
Extends: AggBucketHolder
Properties
| Property | Returns | Description |
|---|---|---|
| from | int | The zero-based offset of the first result on this page, within the full set of matching results. |
| searchResults | List<SearchResult> | The search results on this page. |
| size | int | The requested maximum number of results on this page. This may be larger than the actual number of results returned by getSearchResults() when fewer matches remain. |
| totalHits | long | The total number of results that matched the search, across all pages, not just those returned by this page. |
Methods
getSearchResults()
Returns: List<SearchResult>
The search results on this page.
getTotalHits()
Returns: long
The total number of results that matched the search, across all pages, not just those returned by this page.
getFrom()
Returns: int
The zero-based offset of the first result on this page, within the full set of matching results.
getSize()
Returns: int
The requested maximum number of results on this page. This may be larger than the actual number of results returned by getSearchResults() when fewer matches remain.