Interface IPercolateQuery

The percolate query can be used to match queries stored in an index

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IPercolateQuery : IQuery

Properties

| Edit this page View Source

Document

The source of the document to percolate.

Declaration
[DataMember(Name = "document")]
object Document { get; set; }
Property Value
Type Description
object
| Edit this page View Source

Documents

The source of the documents to percolate. Like Document but allows multiple documents to be percolated.

Declaration
[DataMember(Name = "documents")]
IEnumerable<object> Documents { get; set; }
Property Value
Type Description
IEnumerable<object>
| Edit this page View Source

Field

The name of the field containing the percolated query on an existing document. This is a required parameter.

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

Id

The id of the document to fetch for percolation. Can be specified to percolate an existing document instead of providing Document

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

Index

The index the document resides in for percolation. Can be specified to percolate an existing document instead of providing Document

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

Preference

Preference to be used to fetch the document to percolate. Can be specified to percolate an existing document instead of providing Document

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

Routing

Routing to be used to fetch the document to percolate. Can be specified to percolate an existing document instead of providing Document

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

Version

The expected version of the document to be fetched for percolation. Can be specified to percolate an existing document instead of providing Document

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

Extension Methods