Class ValidateQueryRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ValidateQueryRequest.Builder>
co.elastic.clients.elasticsearch.indices.ValidateQueryRequest.Builder
- All Implemented Interfaces:
WithJson<ValidateQueryRequest.Builder>
,ObjectBuilder<ValidateQueryRequest>
- Enclosing class:
- ValidateQueryRequest
public static class ValidateQueryRequest.Builder
extends RequestBase.AbstractBuilder<ValidateQueryRequest.Builder>
implements ObjectBuilder<ValidateQueryRequest>
Builder for
ValidateQueryRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.Execute validation on all shards instead of one random shard per indexThe analyzer to use for the query stringanalyzeWildcard
(Boolean value) Specify whether wildcard and prefix queries should be analyzed (default: false)build()
Builds aValidateQueryRequest
.defaultOperator
(Operator value) The default operator for query string query (AND or OR)The field to use as default where no field prefix is given in the query stringexpandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.Return detailed information about the errorignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)A comma-separated list of index names to restrict the operation; use_all
or empty string to perform the operation on all indicesA comma-separated list of index names to restrict the operation; use_all
or empty string to perform the operation on all indicesSpecify whether format-based query failures (such as providing text to a numeric field) should be ignoredQuery in the Lucene query string syntaxAPI name:query
API name:query
Provide a more detailed explanation showing the actual Lucene query that will be executed.protected ValidateQueryRequest.Builder
self()
A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all typesA 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.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final ValidateQueryRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
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
Adds all elements of
list
toindex
. -
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
Adds one or more values to
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
-
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
Adds all elements of
list
totype
. -
type
A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all typesAPI name:
type
Adds one or more values to
type
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ValidateQueryRequest.Builder>
-
build
Builds aValidateQueryRequest
.- Specified by:
build
in interfaceObjectBuilder<ValidateQueryRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-