Class RegexpQueryDescriptor<T>

Queries documents that contain terms matching a regular expression.

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

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

Flags(string)

Enables optional operators for the regular expression.

Declaration
public RegexpQueryDescriptor<T> Flags(string flags)
Parameters
Type Name Description
string flags
Returns
Type Description
RegexpQueryDescriptor<T>
| Edit this page View Source

MaximumDeterminizedStates(int?)

Maximum number of automaton states required for the query. Default is 10000.

OpenSearch uses Apache Lucene internally to parse regular expressions. Lucene converts each regular expression to a finite automaton containing a number of determinized states.

You can use this parameter to prevent that conversion from unintentionally consuming too many resources. You may need to increase this limit to run complex regular expressions.
Declaration
public RegexpQueryDescriptor<T> MaximumDeterminizedStates(int? maxDeterminizedStates)
Parameters
Type Name Description
int? maxDeterminizedStates
Returns
Type Description
RegexpQueryDescriptor<T>
| Edit this page View Source

Rewrite(MultiTermQueryRewrite)

Method used to rewrite the query.

Declaration
public RegexpQueryDescriptor<T> Rewrite(MultiTermQueryRewrite rewrite)
Parameters
Type Name Description
MultiTermQueryRewrite rewrite
Returns
Type Description
RegexpQueryDescriptor<T>
| Edit this page View Source

Value(string)

Regular expression for terms you wish to find in the provided field

Declaration
public RegexpQueryDescriptor<T> Value(string regex)
Parameters
Type Name Description
string regex
Returns
Type Description
RegexpQueryDescriptor<T>

Implements

Extension Methods