Package org.opensearch.client.opensearch.core.rank_eval

Class RankEvalMetricDiscountedCumulativeGain.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase.AbstractBuilder<RankEvalMetricDiscountedCumulativeGain.Builder>

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricDiscountedCumulativeGain.Builder

All Implemented Interfaces:

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

Enclosing class:

RankEvalMetricDiscountedCumulativeGain

public static class RankEvalMetricDiscountedCumulativeGain.Builder
extends RankEvalMetricBase.AbstractBuilder<RankEvalMetricDiscountedCumulativeGain.Builder>
implements CopyableBuilder<RankEvalMetricDiscountedCumulativeGain.Builder,RankEvalMetricDiscountedCumulativeGain>

Builder for RankEvalMetricDiscountedCumulativeGain.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetricDiscountedCumulativeGain	build()	Builds a RankEvalMetricDiscountedCumulativeGain.
RankEvalMetricDiscountedCumulativeGain.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalMetricDiscountedCumulativeGain.Builder	normalize(Boolean value)	When true, calculates the normalized discounted cumulative gain (nDCG).
protected RankEvalMetricDiscountedCumulativeGain.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase.AbstractBuilder

k

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 RankEvalMetricDiscountedCumulativeGain.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<RankEvalMetricDiscountedCumulativeGain.Builder,RankEvalMetricDiscountedCumulativeGain>

Returns:

a new builder instance.

self

@Nonnull
protected RankEvalMetricDiscountedCumulativeGain.Builder self()

Specified by:

self in class RankEvalMetricBase.AbstractBuilder<RankEvalMetricDiscountedCumulativeGain.Builder>

normalize

@Nonnull
public final RankEvalMetricDiscountedCumulativeGain.Builder normalize(@Nullable
 Boolean value)

When true, calculates the normalized discounted cumulative gain (nDCG).

API name: normalize

build

@Nonnull
public RankEvalMetricDiscountedCumulativeGain build()

Builds a RankEvalMetricDiscountedCumulativeGain.

Specified by:

build in interface ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>

Throws:

NullPointerException - if some of the required fields are null.