Class ValidateQueryRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.ValidateQueryRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class ValidateQueryRequest
extends RequestBase
implements JsonpSerializable
Validates a potentially expensive query without executing it.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<ValidateQueryRequest>
Json deserializer forValidateQueryRequest
static final Endpoint<ValidateQueryRequest,
ValidateQueryResponse, ErrorResponse> Endpoint "indices.validate_query
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final Boolean
Iftrue
, the validation is executed on all shards instead of one random shard per index.final String
analyzer()
Analyzer to use for the query string.final Boolean
Iftrue
, wildcard and prefix queries are analyzed.final Operator
The default operator for query string query:AND
orOR
.final String
df()
Field to use as default where no field prefix is given in the query string.final List<ExpandWildcard>
Type of index that wildcard patterns can match.final Boolean
explain()
Iftrue
, the response returns detailed information if an error has occurred.final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.index()
Comma-separated list of data streams, indices, and aliases to search.final Boolean
lenient()
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.static ValidateQueryRequest
final String
q()
Query in the Lucene query string syntax.final Query
query()
Query in the Lucene query string syntax.final Boolean
rewrite()
Iftrue
, returns 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
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forValidateQueryRequest
-
_ENDPOINT
Endpoint "indices.validate_query
".
-
-
Method Details
-
of
public static ValidateQueryRequest of(Function<ValidateQueryRequest.Builder, ObjectBuilder<ValidateQueryRequest>> fn) -
allShards
Iftrue
, the validation is executed on all shards instead of one random shard per index.API name:
all_shards
-
allowNoIndices
Iffalse
, 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.API name:
allow_no_indices
-
analyzeWildcard
Iftrue
, wildcard and prefix queries are analyzed.API name:
analyze_wildcard
-
analyzer
Analyzer to use for the query string. This parameter can only be used when theq
query string parameter is specified.API name:
analyzer
-
defaultOperator
The default operator for query string query:AND
orOR
.API name:
default_operator
-
df
Field to use as default where no field prefix is given in the query string. This parameter can only be used when theq
query string parameter is specified.API name:
df
-
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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
-
explain
Iftrue
, the response returns detailed information if an error has occurred.API name:
explain
-
index
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
.API name:
index
-
lenient
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.API name:
lenient
-
q
Query in the Lucene query string syntax.API name:
q
-
query
Query in the Lucene query string syntax.API name:
query
-
rewrite
Iftrue
, returns a more detailed explanation showing the actual Lucene query that will be executed.API name:
rewrite
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupValidateQueryRequestDeserializer
protected static void setupValidateQueryRequestDeserializer(ObjectDeserializer<ValidateQueryRequest.Builder> op)
-