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

Class RankEvalMetricExpectedReciprocalRank.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricExpectedReciprocalRank.Builder

All Implemented Interfaces:

ObjectBuilder<RankEvalMetricExpectedReciprocalRank>

Enclosing class:

RankEvalMetricExpectedReciprocalRank

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

Builder for RankEvalMetricExpectedReciprocalRank.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetricExpectedReciprocalRank	build()	Builds a RankEvalMetricExpectedReciprocalRank.
RankEvalMetricExpectedReciprocalRank.Builder	maximumRelevance(int value)	Required - The highest relevance grade used in the user-supplied relevance judgments.
protected RankEvalMetricExpectedReciprocalRank.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

maximumRelevance

public final RankEvalMetricExpectedReciprocalRank.Builder maximumRelevance(int value)

Required - The highest relevance grade used in the user-supplied relevance judgments.

API name: maximum_relevance

self

protected RankEvalMetricExpectedReciprocalRank.Builder self()

Specified by:

self in class RankEvalMetricBase.AbstractBuilder<RankEvalMetricExpectedReciprocalRank.Builder>

build

public RankEvalMetricExpectedReciprocalRank build()

Builds a RankEvalMetricExpectedReciprocalRank.

Specified by:

build in interface ObjectBuilder<RankEvalMetricExpectedReciprocalRank>

Throws:

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