Package org.opensearch.client.opensearch.core

Class ExplainResponse<TDocument>

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class ExplainResponse<TDocument>
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ExplainResponse<Object>>	_DESERIALIZER	Json deserializer for ExplainResponse based on named deserializers provided by the calling JsonMapper.

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<ExplainResponse<TDocument>>	createExplainResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for ExplainResponse
final Explanation	explanation()	API name: explanation
final InlineGet<TDocument>	get()	API name: get
final String	id()	Required - API name: _id
final String	index()	Required - API name: _index
final boolean	matched()	Required - API name: matched
static <TDocument> ExplainResponse<TDocument>	of(Function<ExplainResponse.Builder<TDocument>,ObjectBuilder<ExplainResponse<TDocument>>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <TDocument> void	setupExplainResponseDeserializer(ObjectDeserializer<ExplainResponse.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ExplainResponse<Object>> _DESERIALIZER

Json deserializer for ExplainResponse based on named deserializers provided by the calling JsonMapper.

Method Details

of

public static <TDocument>
ExplainResponse<TDocument> of(Function<ExplainResponse.Builder<TDocument>,ObjectBuilder<ExplainResponse<TDocument>>> fn)

index

public final String index()

Required - API name: _index

id

public final String id()

Required - API name: _id

matched

public final boolean matched()

Required - API name: matched

explanation

@Nullable
public final Explanation explanation()

API name: explanation

get

@Nullable
public final InlineGet<TDocument> get()

API name: get

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(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(ObjectDeserializer<ExplainResponse.Builder<TDocument>> op,
 JsonpDeserializer<TDocument> tDocumentDeserializer)