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) Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.Iftrue
, the validation is executed on all shards instead of one random shard per index.Analyzer to use for the query string.analyzeWildcard
(Boolean value) Iftrue
, wildcard and prefix queries are analyzed.build()
Builds aValidateQueryRequest
.defaultOperator
(Operator value) The default operator for query string query:AND
orOR
.Field to use as default where no field prefix is given in the query string.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.Iftrue
, the response returns detailed information if an error has occurred.ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.Comma-separated list of data streams, indices, and aliases to search.Comma-separated list of data streams, indices, and aliases to search.Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.Query in the Lucene query string syntax.Query in the Lucene query string syntax.Query in the Lucene query string syntax.Iftrue
, returns a more detailed explanation showing the actual Lucene query that will be executed.protected ValidateQueryRequest.Builder
self()
Methods 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
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
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final ValidateQueryRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) 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
Adds one or more values to
expandWildcards
. -
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
Adds all elements of
list
toindex
. -
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
Adds one or more values to
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
-
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
-
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.
-