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:

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

Enclosing class:

RankEvalRequestItem

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

Builder for RankEvalRequestItem.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalRequestItem	build()	Builds a RankEvalRequestItem.
RankEvalRequestItem.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalRequestItem.Builder	id(String value)	Required - API name: id
final RankEvalRequestItem.Builder	params(String key, JsonData value)	The search template parameters.
final RankEvalRequestItem.Builder	params(Map<String,JsonData> map)	The search template parameters.
final RankEvalRequestItem.Builder	ratings(Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)	Required - A list of document ratings.
final RankEvalRequestItem.Builder	ratings(List<DocumentRating> list)	Required - A list of document ratings.
final RankEvalRequestItem.Builder	ratings(DocumentRating value, DocumentRating... values)	Required - A list of document ratings.
final RankEvalRequestItem.Builder	request(Function<RankEvalQuery.Builder,ObjectBuilder<RankEvalQuery>> fn)	API name: request
final RankEvalRequestItem.Builder	request(RankEvalQuery value)	API name: request
final RankEvalRequestItem.Builder	templateId(String value)	API name: template_id

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

Returns:

a new builder instance.

id

@Nonnull
public final RankEvalRequestItem.Builder id(String value)

Required - API name: id

params

@Nonnull
public final RankEvalRequestItem.Builder params(Map<String,JsonData> map)

The search template parameters.

API name: params

Adds all elements of map to params.

params

@Nonnull
public final RankEvalRequestItem.Builder params(String key,
 JsonData value)

The search template parameters.

API name: params

Adds an entry to params.

ratings

@Nonnull
public final RankEvalRequestItem.Builder ratings(List<DocumentRating> list)

Required - A list of document ratings.

API name: ratings

Adds all elements of list to ratings.

ratings

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

Required - A list of document ratings.

API name: ratings

Adds one or more values to ratings.

ratings

@Nonnull
public final RankEvalRequestItem.Builder ratings(Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)

Required - A list of document ratings.

API name: ratings

Adds a value to ratings using a builder lambda.

request

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

API name: request

request

@Nonnull
public final RankEvalRequestItem.Builder request(Function<RankEvalQuery.Builder,ObjectBuilder<RankEvalQuery>> fn)

API name: request

templateId

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

API name: template_id

build

@Nonnull
public RankEvalRequestItem build()

Builds a RankEvalRequestItem.

Specified by:

build in interface ObjectBuilder<RankEvalRequestItem>

Throws:

NullPointerException - if some of the required fields are null.