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:

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

Enclosing class:

RankEvalMetricExpectedReciprocalRank

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

Builder for RankEvalMetricExpectedReciprocalRank.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalMetricExpectedReciprocalRank	build()	Builds a RankEvalMetricExpectedReciprocalRank.
RankEvalMetricExpectedReciprocalRank.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalMetricExpectedReciprocalRank.Builder	maximumRelevance(int value)	Required - The highest relevance grade used in 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, _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 RankEvalMetricExpectedReciprocalRank.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<RankEvalMetricExpectedReciprocalRank.Builder,RankEvalMetricExpectedReciprocalRank>

Returns:

a new builder instance.

self

@Nonnull
protected RankEvalMetricExpectedReciprocalRank.Builder self()

Specified by:

self in class RankEvalMetricBase.AbstractBuilder<RankEvalMetricExpectedReciprocalRank.Builder>

maximumRelevance

@Nonnull
public final RankEvalMetricExpectedReciprocalRank.Builder maximumRelevance(int value)

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

API name: maximum_relevance

build

@Nonnull
public RankEvalMetricExpectedReciprocalRank build()

Builds a RankEvalMetricExpectedReciprocalRank.

Specified by:

build in interface ObjectBuilder<RankEvalMetricExpectedReciprocalRank>

Throws:

NullPointerException - if some of the required fields are null.