Class ValidateQueryDescriptor<TDocument>
Descriptor for ValidateQuery
https://opensearch.org/docs/latest
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?)
If true, the validation is executed 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?)
If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.
Declaration
public ValidateQueryDescriptor<TDocument> AllowNoIndices(bool? allownoindices = true)
Parameters
| Type |
Name |
Description |
| bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
AnalyzeWildcard(bool?)
If true, wildcard and prefix queries are analyzed.
Declaration
public ValidateQueryDescriptor<TDocument> AnalyzeWildcard(bool? analyzewildcard = true)
Parameters
| Type |
Name |
Description |
| bool? |
analyzewildcard |
|
Returns
|
Edit this page
View Source
Analyzer(string)
Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.
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)
Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.
Declaration
public ValidateQueryDescriptor<TDocument> Df(string df)
Parameters
| Type |
Name |
Description |
| string |
df |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.
Declaration
public ValidateQueryDescriptor<TDocument> ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
Explain(bool?)
If true, the response returns detailed information if an error has occurred.
Declaration
public ValidateQueryDescriptor<TDocument> Explain(bool? explain = true)
Parameters
| Type |
Name |
Description |
| bool? |
explain |
|
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
If false, the request returns an error if it targets a missing or closed index.
Declaration
public ValidateQueryDescriptor<TDocument> IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
| Type |
Name |
Description |
| bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
Index(Indices)
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). To search all data streams or indices, omit this parameter or use * or _all.
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?)
If true, format-based query failures (such as providing text to a numeric field) in the query string will 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?)
If true, returns 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