co.elastic.clients.elasticsearch.ml.TotalFeatureImportanceStatistics Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* 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.ml;
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.Integer;
import java.util.Objects;
import java.util.function.Function;
// typedef: ml._types.TotalFeatureImportanceStatistics
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class TotalFeatureImportanceStatistics implements JsonpSerializable {
private final double meanMagnitude;
private final int max;
private final int min;
// ---------------------------------------------------------------------------------------------
private TotalFeatureImportanceStatistics(Builder builder) {
this.meanMagnitude = ApiTypeHelper.requireNonNull(builder.meanMagnitude, this, "meanMagnitude");
this.max = ApiTypeHelper.requireNonNull(builder.max, this, "max");
this.min = ApiTypeHelper.requireNonNull(builder.min, this, "min");
}
public static TotalFeatureImportanceStatistics of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The average magnitude of this feature across all the training
* data. This value is the average of the absolute values of the importance for
* this feature.
*
* API name: {@code mean_magnitude}
*/
public final double meanMagnitude() {
return this.meanMagnitude;
}
/**
* Required - The maximum importance value across all the training data for this
* feature.
*
* API name: {@code max}
*/
public final int max() {
return this.max;
}
/**
* Required - The minimum importance value across all the training data for this
* feature.
*
* API name: {@code min}
*/
public final int min() {
return this.min;
}
/**
* 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("mean_magnitude");
generator.write(this.meanMagnitude);
generator.writeKey("max");
generator.write(this.max);
generator.writeKey("min");
generator.write(this.min);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link TotalFeatureImportanceStatistics}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private Double meanMagnitude;
private Integer max;
private Integer min;
/**
* Required - The average magnitude of this feature across all the training
* data. This value is the average of the absolute values of the importance for
* this feature.
*
* API name: {@code mean_magnitude}
*/
public final Builder meanMagnitude(double value) {
this.meanMagnitude = value;
return this;
}
/**
* Required - The maximum importance value across all the training data for this
* feature.
*
* API name: {@code max}
*/
public final Builder max(int value) {
this.max = value;
return this;
}
/**
* Required - The minimum importance value across all the training data for this
* feature.
*
* API name: {@code min}
*/
public final Builder min(int value) {
this.min = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link TotalFeatureImportanceStatistics}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public TotalFeatureImportanceStatistics build() {
_checkSingleUse();
return new TotalFeatureImportanceStatistics(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link TotalFeatureImportanceStatistics}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, TotalFeatureImportanceStatistics::setupTotalFeatureImportanceStatisticsDeserializer);
protected static void setupTotalFeatureImportanceStatisticsDeserializer(
ObjectDeserializer op) {
op.add(Builder::meanMagnitude, JsonpDeserializer.doubleDeserializer(), "mean_magnitude");
op.add(Builder::max, JsonpDeserializer.integerDeserializer(), "max");
op.add(Builder::min, JsonpDeserializer.integerDeserializer(), "min");
}
}