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:

ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>

Enclosing class:

RankEvalMetricDiscountedCumulativeGain

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

Builder for RankEvalMetricDiscountedCumulativeGain.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetricDiscountedCumulativeGain	build()	Builds a RankEvalMetricDiscountedCumulativeGain.
RankEvalMetricDiscountedCumulativeGain.Builder	normalize(java.lang.Boolean value)	If set to true, this metric will calculate the Normalized DCG.
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, _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

normalize

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

If set to true, this metric will calculate the Normalized DCG.

API name: normalize

self

protected RankEvalMetricDiscountedCumulativeGain.Builder self()

Specified by:

self in class RankEvalMetricBase.AbstractBuilder<RankEvalMetricDiscountedCumulativeGain.Builder>

build

public RankEvalMetricDiscountedCumulativeGain build()

Builds a RankEvalMetricDiscountedCumulativeGain.

Specified by:

build in interface ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>

Throws:

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