Class ValidateQueryRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<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 WithJsonObjectBuilderBase<ValidateQueryRequest.Builder> implements ObjectBuilder<ValidateQueryRequest>
Builder for
ValidateQueryRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ValidateQueryRequest.Builder
allowNoIndices(java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices.ValidateQueryRequest.Builder
allShards(java.lang.Boolean value)
Execute validation on all shards instead of one random shard per indexValidateQueryRequest.Builder
analyzer(java.lang.String value)
The analyzer to use for the query stringValidateQueryRequest.Builder
analyzeWildcard(java.lang.Boolean value)
Specify whether wildcard and prefix queries should be analyzed (default: false)ValidateQueryRequest
build()
Builds aValidateQueryRequest
.ValidateQueryRequest.Builder
defaultOperator(Operator value)
The default operator for query string query (AND or OR)ValidateQueryRequest.Builder
df(java.lang.String value)
The field to use as default where no field prefix is given in the query stringValidateQueryRequest.Builder
expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Whether to expand wildcard expression to concrete indices that are open, closed or both.ValidateQueryRequest.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
Whether to expand wildcard expression to concrete indices that are open, closed or both.ValidateQueryRequest.Builder
explain(java.lang.Boolean value)
Return detailed information about the errorValidateQueryRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
Whether specified concrete indices should be ignored when unavailable (missing or closed)ValidateQueryRequest.Builder
index(java.lang.String value, java.lang.String... values)
A comma-separated list of index names to restrict the operation; use_all
or empty string to perform the operation on all indicesValidateQueryRequest.Builder
index(java.util.List<java.lang.String> list)
A comma-separated list of index names to restrict the operation; use_all
or empty string to perform the operation on all indicesValidateQueryRequest.Builder
lenient(java.lang.Boolean value)
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredValidateQueryRequest.Builder
q(java.lang.String value)
Query in the Lucene query string syntaxValidateQueryRequest.Builder
query(Query value)
API name:query
ValidateQueryRequest.Builder
query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
API name:query
ValidateQueryRequest.Builder
rewrite(java.lang.Boolean value)
Provide 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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
public final ValidateQueryRequest.Builder index(java.lang.String value, java.lang.String... values)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
public final ValidateQueryRequest.Builder query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:query
-
rewrite
Provide a more detailed explanation showing the actual Lucene query that will be executed.API name:
rewrite
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<ValidateQueryRequest.Builder>
-
build
Builds aValidateQueryRequest
.- Specified by:
build
in interfaceObjectBuilder<ValidateQueryRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-