co.elastic.clients.elasticsearch.ml.EvaluateDataFrameResponse Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* 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.ml;
import co.elastic.clients.elasticsearch.ml.evaluate_data_frame.DataframeClassificationSummary;
import co.elastic.clients.elasticsearch.ml.evaluate_data_frame.DataframeOutlierDetectionSummary;
import co.elastic.clients.elasticsearch.ml.evaluate_data_frame.DataframeRegressionSummary;
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.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.util.Objects;
import java.util.function.Function;
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: ml.evaluate_data_frame.Response
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class EvaluateDataFrameResponse implements JsonpSerializable {
@Nullable
private final DataframeClassificationSummary classification;
@Nullable
private final DataframeOutlierDetectionSummary outlierDetection;
@Nullable
private final DataframeRegressionSummary regression;
// ---------------------------------------------------------------------------------------------
private EvaluateDataFrameResponse(Builder builder) {
this.classification = builder.classification;
this.outlierDetection = builder.outlierDetection;
this.regression = builder.regression;
}
public static EvaluateDataFrameResponse of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Evaluation results for a classification analysis. It outputs a prediction
* that identifies to which of the classes each document belongs.
*
* API name: {@code classification}
*/
@Nullable
public final DataframeClassificationSummary classification() {
return this.classification;
}
/**
* Evaluation results for an outlier detection analysis. It outputs the
* probability that each document is an outlier.
*
* API name: {@code outlier_detection}
*/
@Nullable
public final DataframeOutlierDetectionSummary outlierDetection() {
return this.outlierDetection;
}
/**
* Evaluation results for a regression analysis which outputs a prediction of
* values.
*
* API name: {@code regression}
*/
@Nullable
public final DataframeRegressionSummary regression() {
return this.regression;
}
/**
* 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.classification != null) {
generator.writeKey("classification");
this.classification.serialize(generator, mapper);
}
if (this.outlierDetection != null) {
generator.writeKey("outlier_detection");
this.outlierDetection.serialize(generator, mapper);
}
if (this.regression != null) {
generator.writeKey("regression");
this.regression.serialize(generator, mapper);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link EvaluateDataFrameResponse}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private DataframeClassificationSummary classification;
@Nullable
private DataframeOutlierDetectionSummary outlierDetection;
@Nullable
private DataframeRegressionSummary regression;
/**
* Evaluation results for a classification analysis. It outputs a prediction
* that identifies to which of the classes each document belongs.
*
* API name: {@code classification}
*/
public final Builder classification(@Nullable DataframeClassificationSummary value) {
this.classification = value;
return this;
}
/**
* Evaluation results for a classification analysis. It outputs a prediction
* that identifies to which of the classes each document belongs.
*
* API name: {@code classification}
*/
public final Builder classification(
Function> fn) {
return this.classification(fn.apply(new DataframeClassificationSummary.Builder()).build());
}
/**
* Evaluation results for an outlier detection analysis. It outputs the
* probability that each document is an outlier.
*
* API name: {@code outlier_detection}
*/
public final Builder outlierDetection(@Nullable DataframeOutlierDetectionSummary value) {
this.outlierDetection = value;
return this;
}
/**
* Evaluation results for an outlier detection analysis. It outputs the
* probability that each document is an outlier.
*
* API name: {@code outlier_detection}
*/
public final Builder outlierDetection(
Function> fn) {
return this.outlierDetection(fn.apply(new DataframeOutlierDetectionSummary.Builder()).build());
}
/**
* Evaluation results for a regression analysis which outputs a prediction of
* values.
*
* API name: {@code regression}
*/
public final Builder regression(@Nullable DataframeRegressionSummary value) {
this.regression = value;
return this;
}
/**
* Evaluation results for a regression analysis which outputs a prediction of
* values.
*
* API name: {@code regression}
*/
public final Builder regression(
Function> fn) {
return this.regression(fn.apply(new DataframeRegressionSummary.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link EvaluateDataFrameResponse}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public EvaluateDataFrameResponse build() {
_checkSingleUse();
return new EvaluateDataFrameResponse(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link EvaluateDataFrameResponse}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, EvaluateDataFrameResponse::setupEvaluateDataFrameResponseDeserializer);
protected static void setupEvaluateDataFrameResponseDeserializer(
ObjectDeserializer op) {
op.add(Builder::classification, DataframeClassificationSummary._DESERIALIZER, "classification");
op.add(Builder::outlierDetection, DataframeOutlierDetectionSummary._DESERIALIZER, "outlier_detection");
op.add(Builder::regression, DataframeRegressionSummary._DESERIALIZER, "regression");
}
}