SearchRow

class SearchRow : SearchFlowItem

One row of a Full-Text Search result.

Represents a document matching the query condition.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
inline fun <T> fieldsAs(serializer: JsonSerializer? = null): T?

Returns fields deserialized into an object of the requested type, or null if there are no fields.

Link copied to clipboard
open override fun toString(): String

Properties

Link copied to clipboard
val explanation: ByteArray

Bytes of JSON Object explaining how the score was calculated, or an empty array if the explain parameter was false.

Link copied to clipboard
val fields: ByteArray?

The bytes of a JSON Object that has the requested document fields, or null if no fields were requested (or none of the requested fields are stored).

Link copied to clipboard
val fragments: Map<String, List<String>>

A map from field name to a list of text fragments from that field containing one or more highlighted match terms.

Link copied to clipboard
val id: String

Document ID.

Link copied to clipboard
val index: String

Name of this index this row came from.

Link copied to clipboard
val keyset: SearchKeyset

Identifies this row's position in the full, unpaginated search results. In order for this to be useful, the query's sort must impose a total ordering on the result set. This is typically done by including byId() as the last sort tier.

Link copied to clipboard
val locations: List<SearchRowLocation>

Where the match terms appear in the document.

Link copied to clipboard
val score: Double

Score assigned to this document (higher means better match).