search:search-client-api/com.tomtom.sdk.search.model.summary/AlongRouteSummary

AlongRouteSummary

data class AlongRouteSummary(val query: String, val queryTime: Duration, val numResults: Int, val offset: Int, val totalResults: Int)

The summary of an Along Route Search API call.

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

Constructors

AlongRouteSummary

fun AlongRouteSummary(query: String, queryTime: Duration, numResults: Int, offset: Int, totalResults: Int)

Properties

val numResults: Int

The number of results returned in this batch.

val offset: Int

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

val query: String

The query that resulted in this response.

val queryTime: Duration

The time it took to process the query.

val totalResults: Int

The total number of results.