Class RankEvalRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<RankEvalRequest.Builder>
co.elastic.clients.elasticsearch.core.RankEvalRequest.Builder
- All Implemented Interfaces:
WithJson<RankEvalRequest.Builder>
,ObjectBuilder<RankEvalRequest>
- Enclosing class:
- RankEvalRequest
public static class RankEvalRequest.Builder
extends RequestBase.AbstractBuilder<RankEvalRequest.Builder>
implements ObjectBuilder<RankEvalRequest>
Builder for
RankEvalRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal RankEvalRequest.Builder
allowNoIndices
(Boolean value) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.build()
Builds aRankEvalRequest
.final RankEvalRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.final RankEvalRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.final RankEvalRequest.Builder
ignoreUnavailable
(Boolean value) If true, missing or closed indices are not included in the response.final RankEvalRequest.Builder
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.final RankEvalRequest.Builder
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.final RankEvalRequest.Builder
metric
(RankEvalMetric value) Definition of the evaluation metric to calculatefinal RankEvalRequest.Builder
Definition of the evaluation metric to calculatefinal RankEvalRequest.Builder
requests
(RankEvalRequestItem value, RankEvalRequestItem... values) Required - A set of typical search requests, together with their provided ratingsfinal RankEvalRequest.Builder
Required - A set of typical search requests, together with their provided ratingsfinal RankEvalRequest.Builder
requests
(List<RankEvalRequestItem> list) Required - A set of typical search requests, together with their provided ratingsfinal RankEvalRequest.Builder
searchType
(String value) Search operation typeprotected RankEvalRequest.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.API name:
allow_no_indices
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final RankEvalRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
index
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.API name:
index
Adds all elements of
list
toindex
. -
index
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (*) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.API name:
index
Adds one or more values to
index
. -
metric
Definition of the evaluation metric to calculateAPI name:
metric
-
metric
public final RankEvalRequest.Builder metric(Function<RankEvalMetric.Builder, ObjectBuilder<RankEvalMetric>> fn) Definition of the evaluation metric to calculateAPI name:
metric
-
requests
Required - A set of typical search requests, together with their provided ratingsAPI name:
requests
Adds all elements of
list
torequests
. -
requests
public final RankEvalRequest.Builder requests(RankEvalRequestItem value, RankEvalRequestItem... values) Required - A set of typical search requests, together with their provided ratingsAPI name:
requests
Adds one or more values to
requests
. -
requests
public final RankEvalRequest.Builder requests(Function<RankEvalRequestItem.Builder, ObjectBuilder<RankEvalRequestItem>> fn) Required - A set of typical search requests, together with their provided ratingsAPI name:
requests
Adds a value to
requests
using a builder lambda. -
searchType
Search operation typeAPI name:
search_type
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<RankEvalRequest.Builder>
-
build
Builds aRankEvalRequest
.- Specified by:
build
in interfaceObjectBuilder<RankEvalRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-