Package org.opensearch.client.opensearch._global

Class ExplainResponse.Builder<TDocument>

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<ExplainResponse<TDocument>>

Enclosing class:

ExplainResponse<TDocument>

public static class ExplainResponse.Builder<TDocument>
extends java.lang.Object
implements ObjectBuilder<ExplainResponse<TDocument>>

Builder for ExplainResponse.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

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)	API name: _id
ExplainResponse.Builder<TDocument>	index(java.lang.String value)	API name: _index
ExplainResponse.Builder<TDocument>	matched(java.lang.Boolean value)	API name: matched
ExplainResponse.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
ExplainResponse.Builder<TDocument>	type(java.lang.String value)	API name: _type

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

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

API name: _index

type

public ExplainResponse.Builder<TDocument> type(@Nullable java.lang.String value)

API name: _type

id

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

API name: _id

matched

public ExplainResponse.Builder<TDocument> matched(java.lang.Boolean value)

API name: matched

explanation

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

API name: explanation

explanation

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

API name: explanation

get

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

API name: get

get

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

API name: get

tDocumentSerializer

public 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.