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:

CopyableBuilder<Explanation.Builder,Explanation>, MutableBuilder<Explanation.Builder,Explanation>, ObjectBuilder<Explanation>

Enclosing class:

Explanation

public static class Explanation.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Explanation.Builder,Explanation>

Builder for Explanation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Explanation	build()	Builds a Explanation.
Explanation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Explanation.Builder	description(String value)	Required - API name: description
final Explanation.Builder	details(Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)	Required - API name: details
final Explanation.Builder	details(List<Explanation> list)	Required - API name: details
final Explanation.Builder	details(Explanation value, Explanation... values)	Required - API name: details
final Explanation.Builder	value(Number value)	Required - API name: value

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public Explanation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<Explanation.Builder,Explanation>

Returns:

a new builder instance.

description

@Nonnull
public final Explanation.Builder description(String value)

Required - API name: description

details

@Nonnull
public final Explanation.Builder details(List<Explanation> list)

Required - API name: details

Adds all elements of list to details.

details

@Nonnull
public final Explanation.Builder details(Explanation value,
 Explanation... values)

Required - API name: details

Adds one or more values to details.

details

@Nonnull
public final Explanation.Builder details(Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)

Required - API name: details

Adds a value to details using a builder lambda.

value

@Nonnull
public final Explanation.Builder value(Number value)

Required - API name: value

build

@Nonnull
public Explanation build()

Builds a Explanation.

Specified by:

build in interface ObjectBuilder<Explanation>

Throws:

NullPointerException - if some of the required fields are null.