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

Class RankEvalMetricDiscountedCumulativeGain

java.lang.Object

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricDiscountedCumulativeGain

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RankEvalMetricDiscountedCumulativeGain.Builder,RankEvalMetricDiscountedCumulativeGain>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RankEvalMetricDiscountedCumulativeGain
extends RankEvalMetricBase
implements ToCopyableBuilder<RankEvalMetricDiscountedCumulativeGain.Builder,RankEvalMetricDiscountedCumulativeGain>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RankEvalMetricDiscountedCumulativeGain.Builder	Builder for RankEvalMetricDiscountedCumulativeGain.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RankEvalMetricDiscountedCumulativeGain>	_DESERIALIZER	Json deserializer for RankEvalMetricDiscountedCumulativeGain

Method Summary

Modifier and Type	Method	Description
static RankEvalMetricDiscountedCumulativeGain.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Boolean	normalize()	When true, calculates the normalized discounted cumulative gain (nDCG).
static RankEvalMetricDiscountedCumulativeGain	of(Function<RankEvalMetricDiscountedCumulativeGain.Builder,ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRankEvalMetricDiscountedCumulativeGainDeserializer(ObjectDeserializer<RankEvalMetricDiscountedCumulativeGain.Builder> op)
RankEvalMetricDiscountedCumulativeGain.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.core.rank_eval.RankEvalMetricBase

k, serialize, setupRankEvalMetricBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RankEvalMetricDiscountedCumulativeGain> _DESERIALIZER

Json deserializer for RankEvalMetricDiscountedCumulativeGain

Method Details

of

public static RankEvalMetricDiscountedCumulativeGain of(Function<RankEvalMetricDiscountedCumulativeGain.Builder,ObjectBuilder<RankEvalMetricDiscountedCumulativeGain>> fn)

normalize

@Nullable
public final Boolean normalize()

When true, calculates the normalized discounted cumulative gain (nDCG).

API name: normalize

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class RankEvalMetricBase

toBuilder

@Nonnull
public RankEvalMetricDiscountedCumulativeGain.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RankEvalMetricDiscountedCumulativeGain.Builder,RankEvalMetricDiscountedCumulativeGain>

Returns:

a new builder instance.

builder

@Nonnull
public static RankEvalMetricDiscountedCumulativeGain.Builder builder()

setupRankEvalMetricDiscountedCumulativeGainDeserializer

protected static void setupRankEvalMetricDiscountedCumulativeGainDeserializer(ObjectDeserializer<RankEvalMetricDiscountedCumulativeGain.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class RankEvalMetricBase

equals

public boolean equals(Object o)

Overrides:

equals in class RankEvalMetricBase