co.elastic.clients.elasticsearch.core.RankEvalResponse 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.core;
import co.elastic.clients.elasticsearch.core.rank_eval.RankEvalMetricDetail;
import co.elastic.clients.json.JsonData;
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.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Double;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: _global.rank_eval.Response
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class RankEvalResponse implements JsonpSerializable {
private final double metricScore;
private final Map details;
private final Map failures;
// ---------------------------------------------------------------------------------------------
private RankEvalResponse(Builder builder) {
this.metricScore = ApiTypeHelper.requireNonNull(builder.metricScore, this, "metricScore");
this.details = ApiTypeHelper.unmodifiableRequired(builder.details, this, "details");
this.failures = ApiTypeHelper.unmodifiableRequired(builder.failures, this, "failures");
}
public static RankEvalResponse of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The overall evaluation quality calculated by the defined metric
*
* API name: {@code metric_score}
*/
public final double metricScore() {
return this.metricScore;
}
/**
* Required - The details section contains one entry for every query in the
* original requests section, keyed by the search request id
*
* API name: {@code details}
*/
public final Map details() {
return this.details;
}
/**
* Required - API name: {@code failures}
*/
public final Map failures() {
return this.failures;
}
/**
* 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) {
generator.writeKey("metric_score");
generator.write(this.metricScore);
if (ApiTypeHelper.isDefined(this.details)) {
generator.writeKey("details");
generator.writeStartObject();
for (Map.Entry item0 : this.details.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.failures)) {
generator.writeKey("failures");
generator.writeStartObject();
for (Map.Entry item0 : this.failures.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link RankEvalResponse}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
private Double metricScore;
private Map details;
private Map failures;
/**
* Required - The overall evaluation quality calculated by the defined metric
*
* API name: {@code metric_score}
*/
public final Builder metricScore(double value) {
this.metricScore = value;
return this;
}
/**
* Required - The details section contains one entry for every query in the
* original requests section, keyed by the search request id
*
* API name: {@code details}
*
* Adds all entries of map to details.
*/
public final Builder details(Map map) {
this.details = _mapPutAll(this.details, map);
return this;
}
/**
* Required - The details section contains one entry for every query in the
* original requests section, keyed by the search request id
*
* API name: {@code details}
*
* Adds an entry to details.
*/
public final Builder details(String key, RankEvalMetricDetail value) {
this.details = _mapPut(this.details, key, value);
return this;
}
/**
* Required - The details section contains one entry for every query in the
* original requests section, keyed by the search request id
*
* API name: {@code details}
*
* Adds an entry to details using a builder lambda.
*/
public final Builder details(String key,
Function> fn) {
return details(key, fn.apply(new RankEvalMetricDetail.Builder()).build());
}
/**
* Required - API name: {@code failures}
*
* Adds all entries of map to failures.
*/
public final Builder failures(Map map) {
this.failures = _mapPutAll(this.failures, map);
return this;
}
/**
* Required - API name: {@code failures}
*
* Adds an entry to failures.
*/
public final Builder failures(String key, JsonData value) {
this.failures = _mapPut(this.failures, key, value);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link RankEvalResponse}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public RankEvalResponse build() {
_checkSingleUse();
return new RankEvalResponse(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link RankEvalResponse}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
RankEvalResponse::setupRankEvalResponseDeserializer);
protected static void setupRankEvalResponseDeserializer(ObjectDeserializer op) {
op.add(Builder::metricScore, JsonpDeserializer.doubleDeserializer(), "metric_score");
op.add(Builder::details, JsonpDeserializer.stringMapDeserializer(RankEvalMetricDetail._DESERIALIZER),
"details");
op.add(Builder::failures, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "failures");
}
}