public class ValidateQueryRequest : PlainRequestBase<ValidateQueryRequestParameters>, IValidateQueryRequest, IRequest<ValidateQueryRequestParameters>, IRequest

Constructors

| Edit this page View Source

ValidateQueryRequest()

/_validate/query

Declaration

public ValidateQueryRequest()

| Edit this page View Source

ValidateQueryRequest(Indices)

/{index}/_validate/query

Declaration

public ValidateQueryRequest(Indices index)

Parameters

Type	Name	Description
Indices	index	Optional, accepts null

Properties

| Edit this page View Source

AllShards

If true, the validation is executed on all shards instead of one random shard per index.

Declaration

public bool? AllShards { get; set; }

Property Value

Type	Description
bool?

| Edit this page View Source

AllowNoIndices

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

Declaration

public bool? AllowNoIndices { get; set; }

Property Value

Type	Description
bool?

| Edit this page View Source

AnalyzeWildcard

If true, wildcard and prefix queries are analyzed.

Declaration

public bool? AnalyzeWildcard { get; set; }

Property Value

Type	Description
bool?

| Edit this page View Source

Analyzer

Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.

Declaration

public string Analyzer { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

DefaultOperator

The default operator for query string query: AND or OR.

Declaration

public DefaultOperator? DefaultOperator { get; set; }

Property Value

Type	Description
DefaultOperator?

| Edit this page View Source

Df

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 string Df { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

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 ExpandWildcards? ExpandWildcards { get; set; }

Property Value

Type	Description
ExpandWildcards?

| Edit this page View Source

Explain

If true, the response returns detailed information if an error has occurred.

Declaration

public bool? Explain { get; set; }

Property Value

Type	Description
bool?

| Edit this page View Source

IgnoreUnavailable

If false, the request returns an error if it targets a missing or closed index.

Declaration

public bool? IgnoreUnavailable { get; set; }

Property Value

Type	Description
bool?

| Edit this page View Source

Lenient

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

Declaration

public bool? Lenient { get; set; }

Property Value

Type	Description
bool?

| Edit this page View Source

Query

Declaration

public QueryContainer Query { get; set; }

Property Value

Type	Description
QueryContainer

| Edit this page View Source

QueryOnQueryString

Query in the Lucene query string syntax.

Declaration

public string QueryOnQueryString { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

Rewrite

If true, returns a more detailed explanation showing the actual Lucene query that will be executed.

Declaration

public bool? Rewrite { get; set; }

Property Value

Type	Description
bool?

| Edit this page View Source

Self

Declaration

protected IValidateQueryRequest Self { get; }

Property Value

Type	Description
IValidateQueryRequest

Implements

IValidateQueryRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)