SearchQueryResults
org.sagebionetworks.repo.model.search.SearchQueryResults
Results of a search query against an OpenSearch index. The set of populated fields is governed by the request's responseParts: hits and offset are populated by default; the remaining fields are populated only when the corresponding SearchQueryPart is requested.
| Field | Type | Description |
|---|---|---|
| concreteType | STRING | |
| hits | ARRAY<SearchHit> | Matching documents. Populated by default (or whenever SearchQueryPart.HITS is requested). |
| totalHits | INTEGER | The total number of matching documents. Populated when SearchQueryPart.TOTAL_HITS is requested. |
| selectColumns | ARRAY<SelectColumn> | The columns represented in each hit's fields, in SELECT-clause order. Populated when SearchQueryPart.SELECT_COLUMNS is requested. When SearchQuery.returnFields is non-empty, this is the subset of columns matching those names. |
| facets | ARRAY<FacetColumnResult> | Facet aggregation results. Populated when SearchQueryPart.FACETS is requested. Autocomplete never produces facets regardless of this part being requested. |
| offset | INTEGER | Zero-based pagination offset echoed from the request. Always populated. |