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, RankEvalMetricRatingThreshold.AbstractBuilder

Enclosing class:

RankEvalMetricBase

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()
protected	AbstractBuilder(RankEvalMetricBase o)
protected	AbstractBuilder(RankEvalMetricBase.AbstractBuilder<BuilderT> o)

Method Summary

Modifier and Type	Method	Description
final BuilderT	k(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, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractBuilder

protected AbstractBuilder()

AbstractBuilder

protected AbstractBuilder(RankEvalMetricBase o)

AbstractBuilder

protected AbstractBuilder(RankEvalMetricBase.AbstractBuilder<BuilderT> o)

Method Details

self

@Nonnull
protected abstract BuilderT self()

k

@Nonnull
public final BuilderT k(@Nullable
 Integer value)

Sets the maximum number of documents retrieved per query. This value replaces the size parameter in the query.

API name: k