Package org.opensearch.client.opensearch.core.explain

Class Explanation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.explain.Explanation.Builder

All Implemented Interfaces:

ObjectBuilder<Explanation>

Enclosing class:

Explanation

public static class Explanation.Builder
extends ObjectBuilderBase
implements ObjectBuilder<Explanation>

Builder for Explanation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Explanation	build()	Builds a Explanation.
Explanation.Builder	description(java.lang.String value)	Required - API name: description
Explanation.Builder	details(java.util.function.Function<ExplanationDetail.Builder,ObjectBuilder<ExplanationDetail>> fn)	Required - API name: details
Explanation.Builder	details(java.util.List<ExplanationDetail> list)	Required - API name: details
Explanation.Builder	details(ExplanationDetail value, ExplanationDetail... values)	Required - API name: details
Explanation.Builder	value(float value)	Required - API name: value

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

description

public final Explanation.Builder description(java.lang.String value)

Required - API name: description

details

public final Explanation.Builder details(java.util.List<ExplanationDetail> list)

Required - API name: details

Adds all elements of list to details.

details

public final Explanation.Builder details(ExplanationDetail value,
                                         ExplanationDetail... values)

Required - API name: details

Adds one or more values to details.

details

public final Explanation.Builder details(java.util.function.Function<ExplanationDetail.Builder,ObjectBuilder<ExplanationDetail>> fn)

Required - API name: details

Adds a value to details using a builder lambda.

value

public final Explanation.Builder value(float value)

Required - API name: value

build

public Explanation build()

Builds a Explanation.

Specified by:

build in interface ObjectBuilder<Explanation>

Throws:

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