Package org.opensearch.client.opensearch._global

Class ExplainRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch._global.ExplainRequest

All Implemented Interfaces:

ToJsonp

public final class ExplainRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<ExplainRequest>	DESERIALIZER	Json deserializer for ExplainRequest

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExplainRequest(ExplainRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.String	analyzer()	API name: analyzer
java.lang.Boolean	analyzeWildcard()	API name: analyze_wildcard
static <TDocument> Endpoint<ExplainRequest,ExplainResponse<TDocument>,OpenSearchError>	createExplainEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "explain" endpoint.
jakarta.json.JsonValue	defaultOperator()	API name: default_operator
java.lang.String	df()	API name: df
java.lang.String	id()	API name: id
java.lang.String	index()	API name: index
java.lang.Boolean	lenient()	API name: lenient
java.lang.String	preference()	API name: preference
java.lang.String	q()	API name: q
QueryContainer	query()	API name: query
java.lang.String	queryOnQueryString()	API name: query_on_query_string
jakarta.json.JsonValue	routing()	API name: routing
protected static void	setupExplainRequestDeserializer(DelegatingDeserializer<ExplainRequest.Builder> op)
jakarta.json.JsonValue	source()	API name: _source
java.util.List<java.lang.String>	sourceExcludes()	API name: _source_excludes
java.util.List<java.lang.String>	sourceIncludes()	API name: _source_includes
java.util.List<java.lang.String>	storedFields()	API name: stored_fields
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.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<ExplainRequest> DESERIALIZER

Json deserializer for ExplainRequest

Constructor Details

ExplainRequest

protected ExplainRequest(ExplainRequest.Builder builder)

Method Details

id

public java.lang.String id()

API name: id

index

public java.lang.String index()

API name: index

type

@Nullable public java.lang.String type()

API name: type

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

lenient

@Nullable public java.lang.Boolean lenient()

API name: lenient

preference

@Nullable public java.lang.String preference()

API name: preference

queryOnQueryString

@Nullable public java.lang.String queryOnQueryString()

API name: query_on_query_string

routing

@Nullable public jakarta.json.JsonValue routing()

API name: routing

source

@Nullable public jakarta.json.JsonValue source()

API name: _source

sourceExcludes

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

API name: _source_excludes

sourceIncludes

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

API name: _source_includes

storedFields

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

API name: stored_fields

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)

setupExplainRequestDeserializer

protected static void setupExplainRequestDeserializer(DelegatingDeserializer<ExplainRequest.Builder> op)

createExplainEndpoint

public static <TDocument> Endpoint<ExplainRequest,ExplainResponse<TDocument>,OpenSearchError> createExplainEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "explain" endpoint.