SearchQueryPart

org.sagebionetworks.repo.model.search.SearchQueryPart

Identifiers for the opt-in parts of a SearchQueryResults that have a real OpenSearch cost. Clients pass a list of these values in SearchIndexQuery.responseParts to widen what the server computes and returns. When the list is null or empty the server returns the default minimal payload — HITS plus the always-populated offset — and skips the corresponding work in OpenSearch (no hit fetch when HITS is omitted, no total-hit tracking when TOTAL_HITS is omitted). Aggregations are not gated by this enum: they are populated on the response whenever the request body supplied aggregations.

Enumeration

name	description
HITS	The matching documents, one SearchHit per row. Returned by default.
TOTAL_HITS	The total number of matches. May exceed the size of the returned hits list when paginated.
SELECT_COLUMNS	The list of SelectColumns describing the shape of each hit's fields.