Package org.opensearch.client.opensearch.indices

Class ValidateQueryRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.ValidateQueryRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ValidateQueryRequest
extends RequestBase
implements JsonpSerializable

Allows a user to validate a potentially expensive query without executing it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValidateQueryRequest.Builder	Builder for ValidateQueryRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<ValidateQueryRequest>	_DESERIALIZER	Json deserializer for ValidateQueryRequest
static Endpoint<ValidateQueryRequest,ValidateQueryResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.validate_query".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
java.lang.Boolean	allShards()	Execute validation on all shards instead of one random shard per index
java.lang.String	analyzer()	The analyzer to use for the query string
java.lang.Boolean	analyzeWildcard()	Specify whether wildcard and prefix queries should be analyzed (default: false)
Operator	defaultOperator()	The default operator for query string query (AND or OR)
java.lang.String	df()	The field to use as default where no field prefix is given in the query string
java.util.List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.lang.Boolean	explain()	Return detailed information about the error
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.util.List<java.lang.String>	index()	A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices
java.lang.Boolean	lenient()	Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
static ValidateQueryRequest	of(java.util.function.Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)
java.lang.String	q()	Query in the Lucene query string syntax
Query	query()	API name: query
java.lang.Boolean	rewrite()	Provide a more detailed explanation showing the actual Lucene query that will be executed.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupValidateQueryRequestDeserializer(ObjectDeserializer<ValidateQueryRequest.Builder> op)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<ValidateQueryRequest> _DESERIALIZER

Json deserializer for ValidateQueryRequest

_ENDPOINT

public static final Endpoint<ValidateQueryRequest,ValidateQueryResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.validate_query".

Method Detail

of

public static ValidateQueryRequest of(java.util.function.Function<ValidateQueryRequest.Builder,ObjectBuilder<ValidateQueryRequest>> fn)

allShards

@Nullable
public final java.lang.Boolean allShards()

Execute validation on all shards instead of one random shard per index

API name: all_shards

allowNoIndices

@Nullable
public final java.lang.Boolean allowNoIndices()

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

analyzeWildcard

@Nullable
public final java.lang.Boolean analyzeWildcard()

Specify whether wildcard and prefix queries should be analyzed (default: false)

API name: analyze_wildcard

analyzer

@Nullable
public final java.lang.String analyzer()

The analyzer to use for the query string

API name: analyzer

defaultOperator

@Nullable
public final Operator defaultOperator()

The default operator for query string query (AND or OR)

API name: default_operator

df

@Nullable
public final java.lang.String df()

The field to use as default where no field prefix is given in the query string

API name: df

expandWildcards

public final java.util.List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

explain

@Nullable
public final java.lang.Boolean explain()

Return detailed information about the error

API name: explain

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final java.util.List<java.lang.String> index()

A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices

API name: index

lenient

@Nullable
public final java.lang.Boolean lenient()

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

API name: lenient

q

@Nullable
public final java.lang.String q()

Query in the Lucene query string syntax

API name: q

query

@Nullable
public final Query query()

API name: query

rewrite

@Nullable
public final java.lang.Boolean rewrite()

Provide a more detailed explanation showing the actual Lucene query that will be executed.

API name: rewrite

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupValidateQueryRequestDeserializer

protected static void setupValidateQueryRequestDeserializer(ObjectDeserializer<ValidateQueryRequest.Builder> op)