SearchRequestSummary

data class SearchRequestSummary(val numResults: Int, val offset: Int, val totalResults: Int, val query: String = "", val geoBias: GeoPoint? = null, val queryTime: Duration? = null)

The summary of a Search API call.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

Link copied to clipboard
fun SearchRequestSummary(numResults: Int, offset: Int, totalResults: Int, query: String = "", geoBias: GeoPoint? = null, queryTime: Duration? = null)

Properties

Link copied to clipboard
val geoBias: GeoPoint? = null

The position used to bias the results.

Link copied to clipboard

The number of results returned in this batch.

Link copied to clipboard
val offset: Int

The offset of the results in the collection of all results.

Link copied to clipboard

The query that resulted in this response.

Link copied to clipboard
val queryTime: Duration? = null

The time it took to process this query.

Link copied to clipboard

The total number of results.