Package org.opensearch.client.opensearch._global

Class ExplainResponse<TDocument>

java.lang.Object

org.opensearch.client.opensearch._global.ExplainResponse<TDocument>

All Implemented Interfaces:

ToJsonp

public final class ExplainResponse<TDocument>
extends java.lang.Object
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExplainResponse.Builder<TDocument>	Builder for ExplainResponse.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExplainResponse(ExplainResponse.Builder<TDocument> builder)

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<ExplainResponse<TDocument>>	createExplainResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a json deserializer for ExplainResponse
ExplanationDetail	explanation()	API name: explanation
InlineGet<TDocument>	get()	API name: get
java.lang.String	id()	API name: _id
java.lang.String	index()	API name: _index
java.lang.Boolean	matched()	API name: matched
protected static <TDocument> void	setupExplainResponseDeserializer(DelegatingDeserializer<ExplainResponse.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
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

Constructor Details

ExplainResponse

protected ExplainResponse(ExplainResponse.Builder<TDocument> builder)

Method Details

index

public java.lang.String index()

API name: _index

type

@Nullable public java.lang.String type()

API name: _type

id

public java.lang.String id()

API name: _id

matched

public java.lang.Boolean matched()

API name: matched

explanation

@Nullable public ExplanationDetail explanation()

API name: explanation

get

@Nullable public InlineGet<TDocument> get()

API name: get

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)

createExplainResponseDeserializer

public static <TDocument> JsonpDeserializer<ExplainResponse<TDocument>> createExplainResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a json deserializer for ExplainResponse

setupExplainResponseDeserializer

protected static <TDocument> void setupExplainResponseDeserializer(DelegatingDeserializer<ExplainResponse.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)