Package org.opensearch.client.opensearch._global.rank_eval

Class RankEvalRequestItem.Builder

java.lang.Object

org.opensearch.client.opensearch._global.rank_eval.RankEvalRequestItem.Builder

All Implemented Interfaces:

ObjectBuilder<RankEvalRequestItem>

Enclosing class:

RankEvalRequestItem

public static class RankEvalRequestItem.Builder
extends java.lang.Object
implements ObjectBuilder<RankEvalRequestItem>

Builder for RankEvalRequestItem.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalRequestItem.Builder	addRatings(java.util.function.Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)	Add a value to ratings(List), creating the list if needed.
RankEvalRequestItem.Builder	addRatings(DocumentRating value)	Add a value to ratings(List), creating the list if needed.
RankEvalRequestItem	build()	Builds a RankEvalRequestItem.
RankEvalRequestItem.Builder	id(java.lang.String value)	The search request's ID, used to group result details later.
RankEvalRequestItem.Builder	params(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	The search template parameters.
RankEvalRequestItem.Builder	putParams(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to params(Map), creating the map if needed.
RankEvalRequestItem.Builder	ratings(java.util.function.Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)	Set ratings(List) to a singleton list.
RankEvalRequestItem.Builder	ratings(java.util.List<DocumentRating> value)	List of document ratings API name: ratings
RankEvalRequestItem.Builder	ratings(DocumentRating... value)	List of document ratings API name: ratings
RankEvalRequestItem.Builder	request(java.util.function.Function<RankEvalQuery.Builder,ObjectBuilder<RankEvalQuery>> fn)	The query being evaluated.
RankEvalRequestItem.Builder	request(RankEvalQuery value)	The query being evaluated.
RankEvalRequestItem.Builder	templateId(java.lang.String value)	The search template Id API name: template_id

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

id

public RankEvalRequestItem.Builder id(java.lang.String value)

The search request's ID, used to group result details later. API name: id

request

public RankEvalRequestItem.Builder request(@Nullable RankEvalQuery value)

The query being evaluated. API name: request

request

public RankEvalRequestItem.Builder request(java.util.function.Function<RankEvalQuery.Builder,ObjectBuilder<RankEvalQuery>> fn)

The query being evaluated. API name: request

ratings

public RankEvalRequestItem.Builder ratings(java.util.List<DocumentRating> value)

List of document ratings API name: ratings

ratings

public RankEvalRequestItem.Builder ratings(DocumentRating... value)

List of document ratings API name: ratings

addRatings

public RankEvalRequestItem.Builder addRatings(DocumentRating value)

Add a value to ratings(List), creating the list if needed.

ratings

public RankEvalRequestItem.Builder ratings(java.util.function.Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)

Set ratings(List) to a singleton list.

addRatings

public RankEvalRequestItem.Builder addRatings(java.util.function.Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)

Add a value to ratings(List), creating the list if needed.

templateId

public RankEvalRequestItem.Builder templateId(@Nullable java.lang.String value)

The search template Id API name: template_id

params

public RankEvalRequestItem.Builder params(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

The search template parameters. API name: params

putParams

public RankEvalRequestItem.Builder putParams(java.lang.String key, jakarta.json.JsonValue value)

Add a key/value to params(Map), creating the map if needed.

build

public RankEvalRequestItem build()

Builds a RankEvalRequestItem.

Specified by:

build in interface ObjectBuilder<RankEvalRequestItem>

Throws:

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