Class Hit<TDocument>

Inheritance
object
Hit<TDocument>
Implements
IHit<TDocument>
IHitMetadata<TDocument>
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class Hit<TDocument> : IHit<TDocument>, IHitMetadata<TDocument> where TDocument : class
Type Parameters
Name Description
TDocument

Properties

| Edit this page View Source

Explanation

An explanation for why the hit is a match for a query

Declaration
public Explanation Explanation { get; }
Property Value
Type Description
Explanation
| Edit this page View Source

Fields

The individual fields requested for a hit

Declaration
public FieldValues Fields { get; }
Property Value
Type Description
FieldValues
| Edit this page View Source

Highlight

The field highlights

Declaration
public IReadOnlyDictionary<string, IReadOnlyCollection<string>> Highlight { get; }
Property Value
Type Description
IReadOnlyDictionary<string, IReadOnlyCollection<string>>
| Edit this page View Source

Id

The id of the hit

Declaration
public string Id { get; }
Property Value
Type Description
string
| Edit this page View Source

Index

The index in which the hit resides

Declaration
public string Index { get; }
Property Value
Type Description
string
| Edit this page View Source

InnerHits

The inner hits

Declaration
public IReadOnlyDictionary<string, InnerHitsResult> InnerHits { get; }
Property Value
Type Description
IReadOnlyDictionary<string, InnerHitsResult>
| Edit this page View Source

MatchedQueries

Which queries the hit is a match for, when a compound query is involved and named queries used

Declaration
public IReadOnlyCollection<string> MatchedQueries { get; }
Property Value
Type Description
IReadOnlyCollection<string>
| Edit this page View Source

Nested

Declaration
public NestedIdentity Nested { get; }
Property Value
Type Description
NestedIdentity
| Edit this page View Source

PrimaryTerm

The primary term of the hit

Declaration
public long? PrimaryTerm { get; }
Property Value
Type Description
long?
| Edit this page View Source

Routing

The routing value for the hit

Declaration
public string Routing { get; }
Property Value
Type Description
string
| Edit this page View Source

Score

The score for the hit in relation to the query

Declaration
public double? Score { get; set; }
Property Value
Type Description
double?
| Edit this page View Source

SequenceNumber

The sequence number for this hit

Declaration
public long? SequenceNumber { get; }
Property Value
Type Description
long?
| Edit this page View Source

Sorts

The sort values used in sorting the hit relative to other hits

Declaration
public IReadOnlyCollection<object> Sorts { get; }
Property Value
Type Description
IReadOnlyCollection<object>
| Edit this page View Source

Source

The source document for the hit

Declaration
public TDocument Source { get; }
Property Value
Type Description
TDocument
| Edit this page View Source

Type

The type of hit

Declaration
public string Type { get; }
Property Value
Type Description
string
| Edit this page View Source

Version

The version of the hit

Declaration
public long Version { get; }
Property Value
Type Description
long

Implements

Extension Methods