Package org.opensearch.client.opensearch.core

Class RankEvalResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.RankEvalResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

RankEvalResponse

public static class RankEvalResponse.Builder
extends ObjectBuilderBase
implements CopyableBuilder<RankEvalResponse.Builder,RankEvalResponse>

Builder for RankEvalResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalResponse	build()	Builds a RankEvalResponse.
RankEvalResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalResponse.Builder	details(String key, Function<RankEvalMetricDetail.Builder,ObjectBuilder<RankEvalMetricDetail>> fn)	Required - The details section contains one entry for every query in the original requests section, keyed by the search request id
final RankEvalResponse.Builder	details(String key, RankEvalMetricDetail value)	Required - The details section contains one entry for every query in the original requests section, keyed by the search request id
final RankEvalResponse.Builder	details(Map<String,RankEvalMetricDetail> map)	Required - The details section contains one entry for every query in the original requests section, keyed by the search request id
final RankEvalResponse.Builder	failures(String key, JsonData value)	Required - API name: failures
final RankEvalResponse.Builder	failures(Map<String,JsonData> map)	Required - API name: failures
final RankEvalResponse.Builder	metricScore(double value)	Required - The overall evaluation quality calculated by the defined metric

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 RankEvalResponse.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<RankEvalResponse.Builder,RankEvalResponse>

Returns:

a new builder instance.

details

@Nonnull
public final RankEvalResponse.Builder details(Map<String,RankEvalMetricDetail> map)

Required - The details section contains one entry for every query in the original requests section, keyed by the search request id

API name: details

Adds all elements of map to details.

details

@Nonnull
public final RankEvalResponse.Builder details(String key,
 RankEvalMetricDetail value)

Required - The details section contains one entry for every query in the original requests section, keyed by the search request id

API name: details

Adds an entry to details.

details

@Nonnull
public final RankEvalResponse.Builder details(String key,
 Function<RankEvalMetricDetail.Builder,ObjectBuilder<RankEvalMetricDetail>> fn)

Required - The details section contains one entry for every query in the original requests section, keyed by the search request id

API name: details

Adds a value to details using a builder lambda.

failures

@Nonnull
public final RankEvalResponse.Builder failures(Map<String,JsonData> map)

Required - API name: failures

Adds all elements of map to failures.

failures

@Nonnull
public final RankEvalResponse.Builder failures(String key,
 JsonData value)

Required - API name: failures

Adds an entry to failures.

metricScore

@Nonnull
public final RankEvalResponse.Builder metricScore(double value)

Required - The overall evaluation quality calculated by the defined metric

API name: metric_score

build

@Nonnull
public RankEvalResponse build()

Builds a RankEvalResponse.

Specified by:

build in interface ObjectBuilder<RankEvalResponse>

Throws:

NullPointerException - if some of the required fields are null.