Class ValidateQueryDescriptor<TDocument>
Descriptor for ValidateQuery
Inheritance
ValidateQueryDescriptor<TDocument>
Assembly: OpenSearch.Client.dll
Syntax
public class ValidateQueryDescriptor<TDocument> : RequestDescriptorBase<ValidateQueryDescriptor<TDocument>, ValidateQueryRequestParameters, IValidateQueryRequest<TDocument>>, IDescriptor, IValidateQueryRequest<TDocument>, IValidateQueryRequest, IRequest<ValidateQueryRequestParameters>, IRequest where TDocument : class
Type Parameters
Name |
Description |
TDocument |
|
Constructors
|
Edit this page
View Source
ValidateQueryDescriptor()
Declaration
public ValidateQueryDescriptor()
|
Edit this page
View Source
ValidateQueryDescriptor(Indices)
Declaration
public ValidateQueryDescriptor(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
Optional, accepts null
|
Methods
|
Edit this page
View Source
AllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public ValidateQueryDescriptor<TDocument> AllIndices()
Returns
|
Edit this page
View Source
AllShards(bool?)
Execute validation on all shards instead of one random shard per index
Declaration
public ValidateQueryDescriptor<TDocument> AllShards(bool? allshards = true)
Parameters
Type |
Name |
Description |
bool? |
allshards |
|
Returns
|
Edit this page
View Source
AllowNoIndices(bool?)
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have been specified)
Declaration
public ValidateQueryDescriptor<TDocument> AllowNoIndices(bool? allownoindices = true)
Parameters
Type |
Name |
Description |
bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
AnalyzeWildcard(bool?)
Specify whether wildcard and prefix queries should be analyzed (default: false)
Declaration
public ValidateQueryDescriptor<TDocument> AnalyzeWildcard(bool? analyzewildcard = true)
Parameters
Type |
Name |
Description |
bool? |
analyzewildcard |
|
Returns
|
Edit this page
View Source
Analyzer(string)
The analyzer to use for the query string
Declaration
public ValidateQueryDescriptor<TDocument> Analyzer(string analyzer)
Parameters
Type |
Name |
Description |
string |
analyzer |
|
Returns
|
Edit this page
View Source
DefaultOperator(DefaultOperator?)
The default operator for query string query (AND or OR)
Declaration
public ValidateQueryDescriptor<TDocument> DefaultOperator(DefaultOperator? defaultoperator)
Parameters
Returns
|
Edit this page
View Source
Df(string)
The field to use as default where no field prefix is given in the query string
Declaration
public ValidateQueryDescriptor<TDocument> Df(string df)
Parameters
Type |
Name |
Description |
string |
df |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public ValidateQueryDescriptor<TDocument> ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
Explain(bool?)
Return detailed information about the error
Declaration
public ValidateQueryDescriptor<TDocument> Explain(bool? explain = true)
Parameters
Type |
Name |
Description |
bool? |
explain |
|
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public ValidateQueryDescriptor<TDocument> IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names to restrict the operation; use the special string _all
or Indices.All to perform the operation on all indices
Declaration
public ValidateQueryDescriptor<TDocument> Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public ValidateQueryDescriptor<TDocument> Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Lenient(bool?)
Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
Declaration
public ValidateQueryDescriptor<TDocument> Lenient(bool? lenient = true)
Parameters
Type |
Name |
Description |
bool? |
lenient |
|
Returns
|
Edit this page
View Source
Query(Func<QueryContainerDescriptor<TDocument>, QueryContainer>)
Declaration
public ValidateQueryDescriptor<TDocument> Query(Func<QueryContainerDescriptor<TDocument>, QueryContainer> querySelector)
Parameters
Returns
|
Edit this page
View Source
QueryOnQueryString(string)
Query in the Lucene query string syntax
Declaration
public ValidateQueryDescriptor<TDocument> QueryOnQueryString(string queryonquerystring)
Parameters
Type |
Name |
Description |
string |
queryonquerystring |
|
Returns
|
Edit this page
View Source
Rewrite(bool?)
Provide a more detailed explanation showing the actual Lucene query that will be executed.
Declaration
public ValidateQueryDescriptor<TDocument> Rewrite(bool? rewrite = true)
Parameters
Type |
Name |
Description |
bool? |
rewrite |
|
Returns
Implements
Extension Methods