Package org.opensearch.action.admin.indices.validate.query

Class ValidateQueryRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<ValidateQueryRequest,ValidateQueryResponse>

org.opensearch.action.support.broadcast.BroadcastOperationRequestBuilder<ValidateQueryRequest,ValidateQueryResponse,ValidateQueryRequestBuilder>

org.opensearch.action.admin.indices.validate.query.ValidateQueryRequestBuilder

@PublicApi(since="1.0.0")
public class ValidateQueryRequestBuilder
extends BroadcastOperationRequestBuilder<ValidateQueryRequest,ValidateQueryResponse,ValidateQueryRequestBuilder>

Transport Request Builder to Validate a Query

Opensearch.api:

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
ValidateQueryRequestBuilder(OpenSearchClient client, ValidateQueryAction action)

Method Summary

Modifier and Type	Method	Description
ValidateQueryRequestBuilder	setAllShards(boolean rewrite)	Indicates whether the query should be validated on all shards
ValidateQueryRequestBuilder	setExplain(boolean explain)	Indicates if detailed information about the query should be returned.
ValidateQueryRequestBuilder	setQuery(QueryBuilder queryBuilder)	The query to validate.
ValidateQueryRequestBuilder	setRewrite(boolean rewrite)	Indicates whether the query should be rewritten into primitive queries

Methods inherited from class org.opensearch.action.support.broadcast.BroadcastOperationRequestBuilder

setIndices, setIndicesOptions

Methods inherited from class org.opensearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ValidateQueryRequestBuilder

public ValidateQueryRequestBuilder(OpenSearchClient client,
 ValidateQueryAction action)

Method Details

setQuery

public ValidateQueryRequestBuilder setQuery(QueryBuilder queryBuilder)

The query to validate.

See Also:

• QueryBuilders

setExplain

public ValidateQueryRequestBuilder setExplain(boolean explain)

Indicates if detailed information about the query should be returned.

See Also:

• QueryBuilders

setRewrite

public ValidateQueryRequestBuilder setRewrite(boolean rewrite)

Indicates whether the query should be rewritten into primitive queries

setAllShards

public ValidateQueryRequestBuilder setAllShards(boolean rewrite)

Indicates whether the query should be validated on all shards