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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aRankEvalRequestItem.copy()Create a new builderCopyableBuilderthat is a copy of this one.Required - API name:idThe search template parameters.The search template parameters.Required - A list of document ratings.ratings(List<DocumentRating> list) Required - A list of document ratings.ratings(DocumentRating value, DocumentRating... values) Required - A list of document ratings.API name:requestrequest(RankEvalQuery value) API name:requesttemplateId(String value) API name:template_idMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<RankEvalRequestItem.Builder,RankEvalRequestItem> - Returns:
- a new builder instance.
-
id
Required - API name:id -
params
The search template parameters.API name:
paramsAdds all elements of
maptoparams. -
params
The search template parameters.API name:
paramsAdds an entry to
params. -
ratings
Required - A list of document ratings.API name:
ratingsAdds all elements of
listtoratings. -
ratings
@Nonnull public final RankEvalRequestItem.Builder ratings(DocumentRating value, DocumentRating... values) Required - A list of document ratings.API name:
ratingsAdds 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:
ratingsAdds a value to
ratingsusing a builder lambda. -
request
API name:request -
request
@Nonnull public final RankEvalRequestItem.Builder request(Function<RankEvalQuery.Builder, ObjectBuilder<RankEvalQuery>> fn) API name:request -
templateId
API name:template_id -
build
Builds aRankEvalRequestItem.- Specified by:
buildin interfaceObjectBuilder<RankEvalRequestItem>- Throws:
NullPointerException- if some of the required fields are null.
-