search-client/com.jillesvangurp.ktsearch/SearchResponse

SearchResponse

@Serializable

data class SearchResponse( val took: Long?, val shards: Shards?, val timedOut: Boolean?, val hits: SearchResponse.Hits?, val aggregations: Aggregations?, val scrollId: String?, val pitId: String?, val pointInTimeId: String?, val suggest: Map<String, List<SearchResponse.Suggest>>?)

Constructors

constructor( took: Long?, shards: Shards?, timedOut: Boolean?, hits: SearchResponse.Hits?, aggregations: Aggregations?, scrollId: String?, pitId: String?, pointInTimeId: String?, suggest: Map<String, List<SearchResponse.Suggest>>?)

Types

@Serializable

data class Hit( val index: String, val type: String?, val id: String, val score: Double?, val source: JsonObject?, val fields: JsonObject?, val sort: JsonArray?, val innerHits: Map<String, HitsContainer>?, val highlight: JsonObject?, val seqNo: Long? = null, val primaryTerm: Long? = null, val version: Long?, val explanation: JsonObject?, val matchedQueries: MatchedQueries?) : SourceInformation

@Serializable

data class Hits(val maxScore: Double?, val total: SearchResponse.Hits.Total?, val hits: List<SearchResponse.Hit>)

@Serializable

data class Suggest(val text: String, val offset: Int, val length: Int, val options: List<SearchResponse.Suggest.Option>)

Properties

val aggregations: Aggregations?

val hits: SearchResponse.Hits?

val SearchResponse.ids: List<String>

@SerialName(value = "pit_id")

val pitId: String?

@SerialName(value = "point_in_time_id")

val pointInTimeId: String?

@SerialName(value = "_scroll_id")

val scrollId: String?

val SearchResponse.searchHits: List<SearchResponse.Hit>

@SerialName(value = "_shards")

val shards: Shards?

val suggest: Map<String, List<SearchResponse.Suggest>>?

@SerialName(value = "timed_out")

val timedOut: Boolean?

val took: Long?

val SearchResponse.total: Long

Functions

fun <T : Any> SearchResponse.parseHits(deserializationStrategy: ModelSerializationStrategy<T>): List<T>

Version of parseHits that reuses the ModelSerializationStrategy.

inline fun <T> SearchResponse.parseHits(json: Json = DEFAULT_JSON): List<T>

Quick way to get the document hits from a SearchResponse. You can override the default json if you need to.

fun <T> SearchResponse.parseHits(deserializationStrategy: DeserializationStrategy<T>, json: Json = DEFAULT_JSON): List<T>

Non reified version of parseHits that takes a deserializationStrategy.