Class PercolateQueryDescriptor<T>

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

Inheritance
object
DescriptorBase<PercolateQueryDescriptor<T>, IPercolateQuery>
QueryDescriptorBase<PercolateQueryDescriptor<T>, IPercolateQuery>
PercolateQueryDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PercolateQueryDescriptor<T> : QueryDescriptorBase<PercolateQueryDescriptor<T>, IPercolateQuery>, IDescriptor, IPercolateQuery, IQuery where T : class
Type Parameters
Name Description
T

The document type that contains the percolated query

Properties

| Edit this page View Source

Conditionless

Whether the query is conditionless. A conditionless query is not serialized as part of the request sent to OpenSearch.

Declaration
protected override bool Conditionless { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

Document<TDocument>(TDocument)

The source of the document to percolate.

Declaration
public PercolateQueryDescriptor<T> Document<TDocument>(TDocument document)
Parameters
Type Name Description
TDocument document
Returns
Type Description
PercolateQueryDescriptor<T>
Type Parameters
Name Description
TDocument
| Edit this page View Source

Documents<TDocument>(IEnumerable<TDocument>)

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

Declaration
public PercolateQueryDescriptor<T> Documents<TDocument>(IEnumerable<TDocument> documents)
Parameters
Type Name Description
IEnumerable<TDocument> documents
Returns
Type Description
PercolateQueryDescriptor<T>
Type Parameters
Name Description
TDocument
| Edit this page View Source

Documents<TDocument>(params TDocument[])

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

Declaration
public PercolateQueryDescriptor<T> Documents<TDocument>(params TDocument[] documents)
Parameters
Type Name Description
TDocument[] documents
Returns
Type Description
PercolateQueryDescriptor<T>
Type Parameters
Name Description
TDocument
| Edit this page View Source

Field(Field)

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

Declaration
public PercolateQueryDescriptor<T> Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
PercolateQueryDescriptor<T>
| Edit this page View Source

Field<TValue>(Expression<Func<T, TValue>>)

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

Declaration
public PercolateQueryDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
PercolateQueryDescriptor<T>
Type Parameters
Name Description
TValue
| Edit this page View Source

Id(string)

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

Declaration
public PercolateQueryDescriptor<T> Id(string id)
Parameters
Type Name Description
string id
Returns
Type Description
PercolateQueryDescriptor<T>
| Edit this page View Source

Index(IndexName)

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

Declaration
public PercolateQueryDescriptor<T> Index(IndexName index)
Parameters
Type Name Description
IndexName index
Returns
Type Description
PercolateQueryDescriptor<T>
| Edit this page View Source

Index<TDocument>()

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

Declaration
public PercolateQueryDescriptor<T> Index<TDocument>()
Returns
Type Description
PercolateQueryDescriptor<T>
Type Parameters
Name Description
TDocument
| Edit this page View Source

Preference(string)

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

Declaration
public PercolateQueryDescriptor<T> Preference(string preference)
Parameters
Type Name Description
string preference
Returns
Type Description
PercolateQueryDescriptor<T>
| Edit this page View Source

Routing(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 PercolateQueryDescriptor<T> Routing(Routing routing)
Parameters
Type Name Description
Routing routing
Returns
Type Description
PercolateQueryDescriptor<T>
| Edit this page View Source

Version(long?)

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 PercolateQueryDescriptor<T> Version(long? version)
Parameters
Type Name Description
long? version
Returns
Type Description
PercolateQueryDescriptor<T>

Implements

Extension Methods