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

Class RankEvalMetricBase.AbstractBuilder<BuilderT extends RankEvalMetricBase.AbstractBuilder<BuilderT>>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase.AbstractBuilder<BuilderT>

Direct Known Subclasses:

RankEvalMetricDiscountedCumulativeGain.Builder, RankEvalMetricExpectedReciprocalRank.Builder, RankEvalMetricRatingTreshold.AbstractBuilder

Enclosing class:

RankEvalMetricBase

protected abstract static class RankEvalMetricBase.AbstractBuilder<BuilderT extends RankEvalMetricBase.AbstractBuilder<BuilderT>>
extends ObjectBuilderBase

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
BuilderT	k(java.lang.Integer value)	Sets the maximum number of documents retrieved per query.
protected abstract BuilderT	self()

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

AbstractBuilder

protected AbstractBuilder()

Method Detail

k

public final BuilderT k(@Nullable
                        java.lang.Integer value)

Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.

API name: k

self

protected abstract BuilderT self()