Package co.elastic.clients.elasticsearch.indices

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ValidateQueryRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
final ValidateQueryRequest.Builder	allShards(Boolean value)	Execute validation on all shards instead of one random shard per index
final ValidateQueryRequest.Builder	analyzer(String value)	The analyzer to use for the query string
final ValidateQueryRequest.Builder	analyzeWildcard(Boolean value)	Specify whether wildcard and prefix queries should be analyzed (default: false)
ValidateQueryRequest	build()	Builds a ValidateQueryRequest.
final ValidateQueryRequest.Builder	defaultOperator(Operator value)	The default operator for query string query (AND or OR)
final ValidateQueryRequest.Builder	df(String value)	The field to use as default where no field prefix is given in the query string
final ValidateQueryRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final ValidateQueryRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final ValidateQueryRequest.Builder	explain(Boolean value)	Return detailed information about the error
final ValidateQueryRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final ValidateQueryRequest.Builder	index(String value, String... values)	A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices
final ValidateQueryRequest.Builder	index(List<String> list)	A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices
final ValidateQueryRequest.Builder	lenient(Boolean value)	Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
final ValidateQueryRequest.Builder	q(String value)	Query in the Lucene query string syntax
final ValidateQueryRequest.Builder	query(Query value)	API name: query
final ValidateQueryRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: query
final ValidateQueryRequest.Builder	rewrite(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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allShards

public final ValidateQueryRequest.Builder allShards(@Nullable
 Boolean value)

Execute validation on all shards instead of one random shard per index

API name: all_shards

allowNoIndices

public final ValidateQueryRequest.Builder allowNoIndices(@Nullable
 Boolean value)

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

public final ValidateQueryRequest.Builder analyzeWildcard(@Nullable
 Boolean value)

Specify whether wildcard and prefix queries should be analyzed (default: false)

API name: analyze_wildcard

analyzer

public final ValidateQueryRequest.Builder analyzer(@Nullable
 String value)

The analyzer to use for the query string

API name: analyzer

defaultOperator

public final ValidateQueryRequest.Builder defaultOperator(@Nullable
 Operator value)

The default operator for query string query (AND or OR)

API name: default_operator

df

public final ValidateQueryRequest.Builder df(@Nullable
 String value)

The field to use as default where no field prefix is given in the query string

API name: df

expandWildcards

public final ValidateQueryRequest.Builder expandWildcards(List<ExpandWildcard> list)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

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

public final ValidateQueryRequest.Builder explain(@Nullable
 Boolean value)

Return detailed information about the error

API name: explain

ignoreUnavailable

public final ValidateQueryRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final ValidateQueryRequest.Builder index(List<String> list)

A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices

API name: index

Adds all elements of list to index.

index

public final ValidateQueryRequest.Builder index(String value,
 String... values)

A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices

API name: index

Adds one or more values to index.

lenient

public final ValidateQueryRequest.Builder lenient(@Nullable
 Boolean value)

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

API name: lenient

q

public final ValidateQueryRequest.Builder q(@Nullable
 String value)

Query in the Lucene query string syntax

API name: q

query

public final ValidateQueryRequest.Builder query(@Nullable
 Query value)

API name: query

query

public final ValidateQueryRequest.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: query

rewrite

public final ValidateQueryRequest.Builder rewrite(@Nullable
 Boolean value)

Provide a more detailed explanation showing the actual Lucene query that will be executed.

API name: rewrite

self

protected ValidateQueryRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ValidateQueryRequest.Builder>

build

public ValidateQueryRequest build()

Builds a ValidateQueryRequest.

Specified by:

build in interface ObjectBuilder<ValidateQueryRequest>

Throws:

NullPointerException - if some of the required fields are null.