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
Allows a user to validate 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
Whether to ignore if a wildcard indices expression resolves into no concrete indices.final Boolean
Execute validation on all shards instead of one random shard per indexfinal String
analyzer()
The analyzer to use for the query stringfinal Boolean
Specify whether wildcard and prefix queries should be analyzed (default: false)final Operator
The default operator for query string query (AND or OR)final String
df()
The field to use as default where no field prefix is given in the query stringfinal List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
explain()
Return detailed information about the errorfinal Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)index()
A comma-separated list of index names to restrict the operation; use_all
or empty string to perform the operation on all indicesfinal Boolean
lenient()
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredstatic ValidateQueryRequest
final String
q()
Query in the Lucene query string syntaxfinal Query
query()
API name:query
final 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
type()
A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all typesMethods 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
Execute validation on all shards instead of one random shard per indexAPI name:
all_shards
-
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
Specify whether wildcard and prefix queries should be analyzed (default: false)API name:
analyze_wildcard
-
analyzer
The analyzer to use for the query stringAPI name:
analyzer
-
defaultOperator
The default operator for query string query (AND or OR)API name:
default_operator
-
df
The field to use as default where no field prefix is given in the query stringAPI name:
df
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
explain
Return detailed information about the errorAPI name:
explain
-
index
A comma-separated list of index names to restrict the operation; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
lenient
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredAPI name:
lenient
-
q
Query in the Lucene query string syntaxAPI name:
q
-
query
API name:query
-
rewrite
Provide a more detailed explanation showing the actual Lucene query that will be executed.API name:
rewrite
-
type
A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all typesAPI name:
type
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupValidateQueryRequestDeserializer
protected static void setupValidateQueryRequestDeserializer(ObjectDeserializer<ValidateQueryRequest.Builder> op)
-