Class PercolateQuery

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

Inheritance

object

QueryBase

PercolateQuery

Implements

IPercolateQuery

IQuery

Inherited Members

QueryBase.Boost

QueryBase.IsStrict

QueryBase.IsVerbatim

QueryBase.IsWritable

QueryBase.Name

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 PercolateQuery : QueryBase, IPercolateQuery, IQuery

Properties

Conditionless

Declaration

protected override bool Conditionless { get; }

Property Value

Type	Description
bool

Overrides

QueryBase.Conditionless

Document

The source of the document to percolate.

Declaration

public object Document { get; set; }

Property Value

Type	Description
object

Documents

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

Declaration

public IEnumerable<object> Documents { get; set; }

Property Value

Type	Description
IEnumerable<object>

Field

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

Declaration

public Field Field { get; set; }

Property Value

Type	Description
Field

Id

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

Declaration

public Id Id { get; set; }

Property Value

Type	Description
Id

Index

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

Declaration

public IndexName Index { get; set; }

Property Value

Type	Description
IndexName

Preference

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

Declaration

public string Preference { get; set; }

Property Value

Type	Description
string

Routing

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

Declaration

public Routing Routing { get; set; }

Property Value

Type	Description
Routing

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

public long? Version { get; set; }

Property Value

Type	Description
long?

Implements

IPercolateQuery

IQuery

Extension Methods

SuffixExtensions.Suffix(object, string)