Class TotalHits

Description of the total number of hits of a query. The total hit count can't generally be computed accurately without visiting all matches, which is costly for queries that match lots of documents. Given that it is often enough to have a lower bounds of the number of hits, such as "there are more than 1000 hits", OpenSearch has options to stop counting as soon as a threshold has been reached in order to improve query times.

Inheritance

object

TotalHits

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class TotalHits

Properties

Relation

Whether Value is the exact hit count, in which case Relation is EqualTo, or a lower bound of the total hit count, in which case Relation is GreaterThanOrEqualTo

Declaration

[DataMember(Name = "relation")]
public TotalHitsRelation? Relation { get; }

Property Value

Type	Description
TotalHitsRelation?

Value

The value of the total hit count. Must be interpreted in the context of Relation

Declaration

[DataMember(Name = "value")]
public long Value { get; }

Property Value

Type	Description
long

Extension Methods

SuffixExtensions.Suffix(object, string)