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 forRankEvalRequestItem.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RankEvalRequestItembuild()Builds aRankEvalRequestItem.RankEvalRequestItem.Builderid(java.lang.String value)Required - The search request's ID, used to group result details later.RankEvalRequestItem.Builderparams(java.lang.String key, JsonData value)The search template parameters.RankEvalRequestItem.Builderparams(java.util.Map<java.lang.String,JsonData> map)The search template parameters.RankEvalRequestItem.Builderratings(java.util.function.Function<DocumentRating.Builder,ObjectBuilder<DocumentRating>> fn)Required - List of document ratingsRankEvalRequestItem.Builderratings(java.util.List<DocumentRating> list)Required - List of document ratingsRankEvalRequestItem.Builderratings(DocumentRating value, DocumentRating... values)Required - List of document ratingsRankEvalRequestItem.Builderrequest(java.util.function.Function<RankEvalQuery.Builder,ObjectBuilder<RankEvalQuery>> fn)The query being evaluated.RankEvalRequestItem.Builderrequest(RankEvalQuery value)The query being evaluated.RankEvalRequestItem.BuildertemplateId(java.lang.String value)The search template Id-
Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
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 ratingsAPI name:
ratingsAdds all elements of
listtoratings.
-
ratings
public final RankEvalRequestItem.Builder ratings(DocumentRating value, DocumentRating... values)
Required - List of document ratingsAPI name:
ratingsAdds 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 ratingsAPI name:
ratingsAdds a value to
ratingsusing a builder lambda.
-
templateId
public final RankEvalRequestItem.Builder templateId(@Nullable java.lang.String value)
The search template IdAPI name:
template_id
-
params
public final RankEvalRequestItem.Builder params(java.util.Map<java.lang.String,JsonData> map)
The search template parameters.API name:
paramsAdds all entries of
maptoparams.
-
params
public final RankEvalRequestItem.Builder params(java.lang.String key, JsonData value)
The search template parameters.API name:
paramsAdds an entry to
params.
-
build
public RankEvalRequestItem build()
Builds aRankEvalRequestItem.- Specified by:
buildin interfaceObjectBuilder<RankEvalRequestItem>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-