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

Class RankEvalQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.rank_eval.RankEvalQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

RankEvalQuery

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

Builder for RankEvalQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RankEvalQuery	build()	Builds a RankEvalQuery.
RankEvalQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RankEvalQuery.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	Required - API name: query
final RankEvalQuery.Builder	query(Query value)	Required - API name: query
final RankEvalQuery.Builder	size(Integer value)	API name: size

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

Returns:

a new builder instance.

query

@Nonnull
public final RankEvalQuery.Builder query(Query value)

Required - API name: query

query

@Nonnull
public final RankEvalQuery.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

Required - API name: query

size

@Nonnull
public final RankEvalQuery.Builder size(@Nullable
 Integer value)

API name: size

build

@Nonnull
public RankEvalQuery build()

Builds a RankEvalQuery.

Specified by:

build in interface ObjectBuilder<RankEvalQuery>

Throws:

NullPointerException - if some of the required fields are null.