Package org.opensearch.client.opensearch.core

Class ExplainResponse.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<ExplainResponse<TDocument>>

Enclosing class:

ExplainResponse<TDocument>

public static class ExplainResponse.Builder<TDocument>
extends ObjectBuilderBase
implements ObjectBuilder<ExplainResponse<TDocument>>

Builder for ExplainResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExplainResponse<TDocument>	build()	Builds a ExplainResponse.
ExplainResponse.Builder<TDocument>	explanation(java.util.function.Function<ExplanationDetail.Builder,ObjectBuilder<ExplanationDetail>> fn)	API name: explanation
ExplainResponse.Builder<TDocument>	explanation(ExplanationDetail value)	API name: explanation
ExplainResponse.Builder<TDocument>	get(java.util.function.Function<InlineGet.Builder<TDocument>,ObjectBuilder<InlineGet<TDocument>>> fn)	API name: get
ExplainResponse.Builder<TDocument>	get(InlineGet<TDocument> value)	API name: get
ExplainResponse.Builder<TDocument>	id(java.lang.String value)	Required - API name: _id
ExplainResponse.Builder<TDocument>	index(java.lang.String value)	Required - API name: _index
ExplainResponse.Builder<TDocument>	matched(boolean value)	Required - API name: matched
ExplainResponse.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

index

public final ExplainResponse.Builder<TDocument> index(java.lang.String value)

Required - API name: _index

id

public final ExplainResponse.Builder<TDocument> id(java.lang.String value)

Required - API name: _id

matched

public final ExplainResponse.Builder<TDocument> matched(boolean value)

Required - API name: matched

explanation

public final ExplainResponse.Builder<TDocument> explanation(@Nullable
                                                            ExplanationDetail value)

API name: explanation

explanation

public final ExplainResponse.Builder<TDocument> explanation(java.util.function.Function<ExplanationDetail.Builder,ObjectBuilder<ExplanationDetail>> fn)

API name: explanation

get

public final ExplainResponse.Builder<TDocument> get(@Nullable
                                                    InlineGet<TDocument> value)

API name: get

get

public final ExplainResponse.Builder<TDocument> get(java.util.function.Function<InlineGet.Builder<TDocument>,ObjectBuilder<InlineGet<TDocument>>> fn)

API name: get

tDocumentSerializer

public final ExplainResponse.Builder<TDocument> tDocumentSerializer(@Nullable
                                                                    JsonpSerializer<TDocument> value)

Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

build

public ExplainResponse<TDocument> build()

Builds a ExplainResponse.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

java.lang.NullPointerException - if some of the required fields are null.