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

Class RankEvalRequestItem.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalRequestItem.Builder

All Implemented Interfaces:

ObjectBuilder<RankEvalRequestItem>

Enclosing class:

RankEvalRequestItem

public static class RankEvalRequestItem.Builder
extends ObjectBuilderBase
implements ObjectBuilder<RankEvalRequestItem>

Builder for RankEvalRequestItem.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalRequestItem	build()	Builds a RankEvalRequestItem.
RankEvalRequestItem.Builder	id(java.lang.String value)	Required - The search request's ID, used to group result details later.
RankEvalRequestItem.Builder	params(java.lang.String key, JsonData value)	The search template parameters.
RankEvalRequestItem.Builder	params(java.util.Map<java.lang.String,JsonData> map)	The search template parameters.
RankEvalRequestItem.Builder	ratings(java.util.function.Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)	Required - List of document ratings
RankEvalRequestItem.Builder	ratings(java.util.List<DocumentRating> list)	Required - List of document ratings
RankEvalRequestItem.Builder	ratings(DocumentRating value, DocumentRating... values)	Required - List of document 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

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

id

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

Required - The search request's ID, used to group result details later.

API name: id

request

public final RankEvalRequestItem.Builder request(@Nullable
                                                 RankEvalQuery value)

The query being evaluated.

API name: request

request

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

The query being evaluated.

API name: request

ratings

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

Required - List of document ratings

API name: ratings

Adds all elements of list to ratings.

ratings

public final RankEvalRequestItem.Builder ratings(DocumentRating value,
                                                 DocumentRating... values)

Required - List of document ratings

API name: ratings

Adds one or more values to ratings.

ratings

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

Required - List of document ratings

API name: ratings

Adds a value to ratings using a builder lambda.

templateId

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

The search template Id

API name: template_id

params

public final RankEvalRequestItem.Builder params(java.util.Map<java.lang.String,JsonData> map)

The search template parameters.

API name: params

Adds all entries of map to params.

params

public final RankEvalRequestItem.Builder params(java.lang.String key,
                                                JsonData value)

The search template parameters.

API name: params

Adds an entry to params.

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.