Interface IHitMetadata<TDocument>

Metadata about a hit matching a query

Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IHitMetadata<out TDocument> where TDocument : class
Type Parameters
Name Description
TDocument

The type of the source document

Properties

| Edit this page View Source

Id

The id of the hit

Declaration
[DataMember(Name = "_id")]
string Id { get; }
Property Value
Type Description
string
| Edit this page View Source

Index

The index in which the hit resides

Declaration
[DataMember(Name = "_index")]
string Index { get; }
Property Value
Type Description
string
| Edit this page View Source

PrimaryTerm

The primary term of the hit

Declaration
[DataMember(Name = "_primary_term")]
long? PrimaryTerm { get; }
Property Value
Type Description
long?
| Edit this page View Source

Routing

The routing value for the hit

Declaration
[DataMember(Name = "_routing")]
string Routing { get; }
Property Value
Type Description
string
| Edit this page View Source

SequenceNumber

The sequence number for this hit

Declaration
[DataMember(Name = "_seq_no")]
long? SequenceNumber { get; }
Property Value
Type Description
long?
| Edit this page View Source

Source

The source document for the hit

Declaration
[DataMember(Name = "_source")]
TDocument Source { get; }
Property Value
Type Description
TDocument
| Edit this page View Source

Type

The type of hit

Declaration
[DataMember(Name = "_type")]
string Type { get; }
Property Value
Type Description
string
| Edit this page View Source

Version

The version of the hit

Declaration
[DataMember(Name = "_version")]
long Version { get; }
Property Value
Type Description
long

Extension Methods