Class Hit<TDocument>
Inheritance
Hit<TDocument>
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
|
Edit this page
View Source
Fields
The individual fields requested for a hit
Declaration
public FieldValues Fields { get; }
Property Value
|
Edit this page
View Source
Highlight
Declaration
public IReadOnlyDictionary<string, IReadOnlyCollection<string>> Highlight { get; }
Property Value
|
Edit this page
View Source
Id
Declaration
public string Id { get; }
Property Value
|
Edit this page
View Source
Index
The index in which the hit resides
Declaration
public string Index { get; }
Property Value
|
Edit this page
View Source
InnerHits
Declaration
public IReadOnlyDictionary<string, InnerHitsResult> InnerHits { get; }
Property Value
|
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
|
Edit this page
View Source
Nested
Declaration
public NestedIdentity Nested { get; }
Property Value
|
Edit this page
View Source
PrimaryTerm
The primary term of the hit
Declaration
public long? PrimaryTerm { get; }
Property Value
|
Edit this page
View Source
Routing
The routing value for the hit
Declaration
public string Routing { get; }
Property Value
|
Edit this page
View Source
Score
The score for the hit in relation to the query
Declaration
public double? Score { get; set; }
Property Value
|
Edit this page
View Source
SequenceNumber
The sequence number for this hit
Declaration
public long? SequenceNumber { get; }
Property Value
|
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
|
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
Declaration
public string Type { get; }
Property Value
|
Edit this page
View Source
Version
Declaration
public long Version { get; }
Property Value
Implements
Extension Methods