Package org.opensearch.client.opensearch.indices

Class ValidateQueryRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.ValidateQueryRequest

All Implemented Interfaces:

ToJsonp

public final class ValidateQueryRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValidateQueryRequest.Builder	Builder for ValidateQueryRequest.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<ValidateQueryRequest>	DESERIALIZER	Json deserializer for ValidateQueryRequest
static Endpoint<ValidateQueryRequest,ValidateQueryResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.validate_query".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ValidateQueryRequest(ValidateQueryRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	API name: allow_no_indices
java.lang.Boolean	allShards()	API name: all_shards
java.lang.String	analyzer()	API name: analyzer
java.lang.Boolean	analyzeWildcard()	API name: analyze_wildcard
jakarta.json.JsonValue	defaultOperator()	API name: default_operator
java.lang.String	df()	API name: df
jakarta.json.JsonValue	expandWildcards()	API name: expand_wildcards
java.lang.Boolean	explain()	API name: explain
java.lang.Boolean	ignoreUnavailable()	API name: ignore_unavailable
java.util.List<java.lang.String>	index()	API name: index
java.lang.Boolean	lenient()	API name: lenient
java.lang.String	q()	API name: q
QueryContainer	query()	API name: query
java.lang.String	queryOnQueryString()	API name: query_on_query_string
java.lang.Boolean	rewrite()	API name: rewrite
protected static void	setupValidateQueryRequestDeserializer(DelegatingDeserializer<ValidateQueryRequest.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.util.List<java.lang.String>	type()	API name: type

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<ValidateQueryRequest> DESERIALIZER

Json deserializer for ValidateQueryRequest

ENDPOINT

public static final Endpoint<ValidateQueryRequest,ValidateQueryResponse,OpenSearchError> ENDPOINT

Endpoint "indices.validate_query".

Constructor Details

ValidateQueryRequest

protected ValidateQueryRequest(ValidateQueryRequest.Builder builder)

Method Details

index

@Nullable public java.util.List<java.lang.String> index()

API name: index

type

@Nullable public java.util.List<java.lang.String> type()

API name: type

allowNoIndices

@Nullable public java.lang.Boolean allowNoIndices()

API name: allow_no_indices

allShards

@Nullable public java.lang.Boolean allShards()

API name: all_shards

analyzer

@Nullable public java.lang.String analyzer()

API name: analyzer

analyzeWildcard

@Nullable public java.lang.Boolean analyzeWildcard()

API name: analyze_wildcard

defaultOperator

@Nullable public jakarta.json.JsonValue defaultOperator()

API name: default_operator

df

@Nullable public java.lang.String df()

API name: df

expandWildcards

@Nullable public jakarta.json.JsonValue expandWildcards()

API name: expand_wildcards

explain

@Nullable public java.lang.Boolean explain()

API name: explain

ignoreUnavailable

@Nullable public java.lang.Boolean ignoreUnavailable()

API name: ignore_unavailable

lenient

@Nullable public java.lang.Boolean lenient()

API name: lenient

queryOnQueryString

@Nullable public java.lang.String queryOnQueryString()

API name: query_on_query_string

rewrite

@Nullable public java.lang.Boolean rewrite()

API name: rewrite

q

@Nullable public java.lang.String q()

API name: q

query

@Nullable public QueryContainer query()

API name: query

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

setupValidateQueryRequestDeserializer

protected static void setupValidateQueryRequestDeserializer(DelegatingDeserializer<ValidateQueryRequest.Builder> op)