Class ValidateQueryRequest.Builder
java.lang.Object
co.elastic.clients.elasticsearch.indices.ValidateQueryRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<ValidateQueryRequest>
- Enclosing class:
- ValidateQueryRequest
public static class ValidateQueryRequest.Builder extends java.lang.Object implements ObjectBuilder<ValidateQueryRequest>
Builder for
ValidateQueryRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ValidateQueryRequest.Builder
addExpandWildcards(ExpandWildcardOptions value)
Add a value toexpandWildcards(List)
, creating the list if needed.ValidateQueryRequest.Builder
addIndex(java.lang.String value)
Add a value toindex(List)
, creating the list if needed.ValidateQueryRequest.Builder
addType(java.lang.String value)
Add a value totype(List)
, creating the list if needed.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(DefaultOperator 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(ExpandWildcardOptions... value)
Whether to expand wildcard expression to concrete indices that are open, closed or both.ValidateQueryRequest.Builder
expandWildcards(java.util.List<ExpandWildcardOptions> value)
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)
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> value)
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.ValidateQueryRequest.Builder
type(java.lang.String... value)
A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all typesValidateQueryRequest.Builder
type(java.util.List<java.lang.String> value)
A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all typesMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
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
-
addIndex
Add a value toindex(List)
, creating the list if needed. -
type
A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all typesAPI name:
type
-
type
A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all typesAPI name:
type
-
addType
Add a value totype(List)
, creating the list if needed. -
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
-
allShards
Execute validation on all shards instead of one random shard per indexAPI name:
all_shards
-
analyzer
The analyzer to use for the query stringAPI name:
analyzer
-
analyzeWildcard
Specify whether wildcard and prefix queries should be analyzed (default: false)API name:
analyze_wildcard
-
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
public ValidateQueryRequest.Builder expandWildcards(@Nullable java.util.List<ExpandWildcardOptions> value)Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
addExpandWildcards
Add a value toexpandWildcards(List)
, creating the list if needed. -
explain
Return detailed information about the errorAPI name:
explain
-
lenient
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredAPI name:
lenient
-
rewrite
Provide a more detailed explanation showing the actual Lucene query that will be executed.API name:
rewrite
-
q
Query in the Lucene query string syntaxAPI name:
q
-
query
API name:query
-
query
public ValidateQueryRequest.Builder query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)API name:query
-
build
Builds aValidateQueryRequest
.- Specified by:
build
in interfaceObjectBuilder<ValidateQueryRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-