TotalHits

class TotalHits

Represents the total number of matching results and indicates how accurate that count is.

The Value field provides the count, which may be exact or estimated. The Relation field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

Link copied to clipboard
val value: Long?

The total number of matching results. This value may be exact or an estimate, depending on the Relation field.

Functions

Link copied to clipboard
inline fun copy(block: TotalHits.Builder.() -> Unit = {}): TotalHits
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String