SearchResponse class

Search operation response.

Inheritance

Constructors

SearchResponse(Map<String, dynamic> raw)
Creates SearchResponse instance.

Properties

disjunctiveFacets ↔ Map<String, List<Facet>>
A mapping of each facet name to the corresponding facet counts for disjunctive facets.
getter/setter pair
exhaustiveNbHits → bool
Whether the nbHits is exhaustive (true) or approximate (false). An approximation is done when the query takes more than 50ms to be processed (this can happen when using complex filters on millions on records).
no setter
facets → Map<String, List<Facet>>
A mapping of each facet name to the corresponding facet counts. Returned only if SearchState.facets is non-empty.
no setter
facetsStats → Map<String, Map<String, num>>
Statistics for numerical facets. Returned only if SearchState.facets is non-empty and at least one of the returned facets contains numerical values.
no setter
hashCode → int
The hash code for this object.
no setteroverride
hierarchicalFacets ↔ Map<String, List<Facet>>
A mapping of each facet name to the corresponding facet counts for hierarchical facets.
getter/setter pair
hits → List<Hit>
Search hits list
final
hitsPerPage → int
The maximum number of hits returned per page. Not returned if you use offset & length for pagination.
no setter
nbHits → int
The number of hits matched by the query.
no setter
nbPages → int
The number of returned pages. Calculation is based on the total number of hits (nbHits) divided by the number of hits per page (hitsPerPage), rounded up to the nearest integer.
no setter
page → int
Index of the current page (zero-based).
no setter
params → String
An url-encoded string of all query parameters.
no setter
processingTimeMS → int
Time the server took to process the request, in milliseconds. This does not include network time.
no setter
query → String
An echo of the query text.
no setter
queryID → String?
Identifies the query uniquely.
no setter
raw → Map<String, dynamic>
Raw search response
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override