co.elastic.clients.elasticsearch.core.RankEvalRequest Maven / Gradle / Ivy
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.core;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.ExpandWildcard;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch.core.rank_eval.RankEvalMetric;
import co.elastic.clients.elasticsearch.core.rank_eval.RankEvalRequestItem;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: _global.rank_eval.Request
/**
* Enables you to evaluate the quality of ranked search results over a set of
* typical search queries.
*
* @see API
* specification
*/
@JsonpDeserializable
public class RankEvalRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Boolean allowNoIndices;
private final List expandWildcards;
@Nullable
private final Boolean ignoreUnavailable;
private final List index;
@Nullable
private final RankEvalMetric metric;
private final List requests;
@Nullable
private final String searchType;
// ---------------------------------------------------------------------------------------------
private RankEvalRequest(Builder builder) {
this.allowNoIndices = builder.allowNoIndices;
this.expandWildcards = ApiTypeHelper.unmodifiable(builder.expandWildcards);
this.ignoreUnavailable = builder.ignoreUnavailable;
this.index = ApiTypeHelper.unmodifiable(builder.index);
this.metric = builder.metric;
this.requests = ApiTypeHelper.unmodifiableRequired(builder.requests, this, "requests");
this.searchType = builder.searchType;
}
public static RankEvalRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* 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: {@code allow_no_indices}
*/
@Nullable
public final Boolean allowNoIndices() {
return this.allowNoIndices;
}
/**
* Whether to expand wildcard expression to concrete indices that are open,
* closed or both.
*
* API name: {@code expand_wildcards}
*/
public final List expandWildcards() {
return this.expandWildcards;
}
/**
* If true, missing or closed indices are not included in the
* response.
*
* API name: {@code ignore_unavailable}
*/
@Nullable
public final Boolean ignoreUnavailable() {
return this.ignoreUnavailable;
}
/**
* 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: {@code index}
*/
public final List index() {
return this.index;
}
/**
* Definition of the evaluation metric to calculate.
*
* API name: {@code metric}
*/
@Nullable
public final RankEvalMetric metric() {
return this.metric;
}
/**
* Required - A set of typical search requests, together with their provided
* ratings.
*
* API name: {@code requests}
*/
public final List requests() {
return this.requests;
}
/**
* Search operation type
*
* API name: {@code search_type}
*/
@Nullable
public final String searchType() {
return this.searchType;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.metric != null) {
generator.writeKey("metric");
this.metric.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.requests)) {
generator.writeKey("requests");
generator.writeStartArray();
for (RankEvalRequestItem item0 : this.requests) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link RankEvalRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private Boolean allowNoIndices;
@Nullable
private List expandWildcards;
@Nullable
private Boolean ignoreUnavailable;
@Nullable
private List index;
@Nullable
private RankEvalMetric metric;
private List requests;
@Nullable
private String searchType;
/**
* 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: {@code allow_no_indices}
*/
public final Builder allowNoIndices(@Nullable Boolean value) {
this.allowNoIndices = value;
return this;
}
/**
* Whether to expand wildcard expression to concrete indices that are open,
* closed or both.
*
* API name: {@code expand_wildcards}
*
* Adds all elements of list to expandWildcards.
*/
public final Builder expandWildcards(List list) {
this.expandWildcards = _listAddAll(this.expandWildcards, list);
return this;
}
/**
* Whether to expand wildcard expression to concrete indices that are open,
* closed or both.
*
* API name: {@code expand_wildcards}
*
* Adds one or more values to expandWildcards.
*/
public final Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) {
this.expandWildcards = _listAdd(this.expandWildcards, value, values);
return this;
}
/**
* If true, missing or closed indices are not included in the
* response.
*
* API name: {@code ignore_unavailable}
*/
public final Builder ignoreUnavailable(@Nullable Boolean value) {
this.ignoreUnavailable = value;
return this;
}
/**
* 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: {@code index}
*
* Adds all elements of list to index.
*/
public final Builder index(List list) {
this.index = _listAddAll(this.index, list);
return this;
}
/**
* 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: {@code index}
*
* Adds one or more values to index.
*/
public final Builder index(String value, String... values) {
this.index = _listAdd(this.index, value, values);
return this;
}
/**
* Definition of the evaluation metric to calculate.
*
* API name: {@code metric}
*/
public final Builder metric(@Nullable RankEvalMetric value) {
this.metric = value;
return this;
}
/**
* Definition of the evaluation metric to calculate.
*
* API name: {@code metric}
*/
public final Builder metric(Function> fn) {
return this.metric(fn.apply(new RankEvalMetric.Builder()).build());
}
/**
* Required - A set of typical search requests, together with their provided
* ratings.
*
* API name: {@code requests}
*
* Adds all elements of list to requests.
*/
public final Builder requests(List list) {
this.requests = _listAddAll(this.requests, list);
return this;
}
/**
* Required - A set of typical search requests, together with their provided
* ratings.
*
* API name: {@code requests}
*
* Adds one or more values to requests.
*/
public final Builder requests(RankEvalRequestItem value, RankEvalRequestItem... values) {
this.requests = _listAdd(this.requests, value, values);
return this;
}
/**
* Required - A set of typical search requests, together with their provided
* ratings.
*
* API name: {@code requests}
*
* Adds a value to requests using a builder lambda.
*/
public final Builder requests(Function> fn) {
return requests(fn.apply(new RankEvalRequestItem.Builder()).build());
}
/**
* Search operation type
*
* API name: {@code search_type}
*/
public final Builder searchType(@Nullable String value) {
this.searchType = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link RankEvalRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public RankEvalRequest build() {
_checkSingleUse();
return new RankEvalRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link RankEvalRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
RankEvalRequest::setupRankEvalRequestDeserializer);
protected static void setupRankEvalRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::metric, RankEvalMetric._DESERIALIZER, "metric");
op.add(Builder::requests, JsonpDeserializer.arrayDeserializer(RankEvalRequestItem._DESERIALIZER), "requests");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code rank_eval}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/rank_eval",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _index = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.index()))
propsSet |= _index;
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_rank_eval");
return buf.toString();
}
if (propsSet == (_index)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index.stream().map(v -> v).collect(Collectors.joining(",")), buf);
buf.append("/_rank_eval");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _index = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.index()))
propsSet |= _index;
if (propsSet == 0) {
}
if (propsSet == (_index)) {
params.put("index", request.index.stream().map(v -> v).collect(Collectors.joining(",")));
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (ApiTypeHelper.isDefined(request.expandWildcards)) {
params.put("expand_wildcards",
request.expandWildcards.stream().map(v -> v.jsonValue()).collect(Collectors.joining(",")));
}
if (request.ignoreUnavailable != null) {
params.put("ignore_unavailable", String.valueOf(request.ignoreUnavailable));
}
if (request.allowNoIndices != null) {
params.put("allow_no_indices", String.valueOf(request.allowNoIndices));
}
if (request.searchType != null) {
params.put("search_type", request.searchType);
}
return params;
}, SimpleEndpoint.emptyMap(), true, RankEvalResponse._DESERIALIZER);
}