co.elastic.clients.elasticsearch.ml.TotalFeatureImportance 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.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.JsonpUtils;
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.String;
import java.util.List;
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._types.TotalFeatureImportance
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class TotalFeatureImportance implements JsonpSerializable {
private final String featureName;
private final List importance;
private final List classes;
// ---------------------------------------------------------------------------------------------
private TotalFeatureImportance(Builder builder) {
this.featureName = ApiTypeHelper.requireNonNull(builder.featureName, this, "featureName");
this.importance = ApiTypeHelper.unmodifiableRequired(builder.importance, this, "importance");
this.classes = ApiTypeHelper.unmodifiableRequired(builder.classes, this, "classes");
}
public static TotalFeatureImportance of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The feature for which this importance was calculated.
*
* API name: {@code feature_name}
*/
public final String featureName() {
return this.featureName;
}
/**
* Required - A collection of feature importance statistics related to the
* training data set for this particular feature.
*
* API name: {@code importance}
*/
public final List importance() {
return this.importance;
}
/**
* Required - If the trained model is a classification model, feature importance
* statistics are gathered per target class value.
*
* API name: {@code classes}
*/
public final List classes() {
return this.classes;
}
/**
* 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("feature_name");
generator.write(this.featureName);
if (ApiTypeHelper.isDefined(this.importance)) {
generator.writeKey("importance");
generator.writeStartArray();
for (TotalFeatureImportanceStatistics item0 : this.importance) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.classes)) {
generator.writeKey("classes");
generator.writeStartArray();
for (TotalFeatureImportanceClass item0 : this.classes) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link TotalFeatureImportance}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private String featureName;
private List importance;
private List classes;
/**
* Required - The feature for which this importance was calculated.
*
* API name: {@code feature_name}
*/
public final Builder featureName(String value) {
this.featureName = value;
return this;
}
/**
* Required - A collection of feature importance statistics related to the
* training data set for this particular feature.
*
* API name: {@code importance}
*
* Adds all elements of list to importance.
*/
public final Builder importance(List list) {
this.importance = _listAddAll(this.importance, list);
return this;
}
/**
* Required - A collection of feature importance statistics related to the
* training data set for this particular feature.
*
* API name: {@code importance}
*
* Adds one or more values to importance.
*/
public final Builder importance(TotalFeatureImportanceStatistics value,
TotalFeatureImportanceStatistics... values) {
this.importance = _listAdd(this.importance, value, values);
return this;
}
/**
* Required - A collection of feature importance statistics related to the
* training data set for this particular feature.
*
* API name: {@code importance}
*
* Adds a value to importance using a builder lambda.
*/
public final Builder importance(
Function> fn) {
return importance(fn.apply(new TotalFeatureImportanceStatistics.Builder()).build());
}
/**
* Required - If the trained model is a classification model, feature importance
* statistics are gathered per target class value.
*
* API name: {@code classes}
*
* Adds all elements of list to classes.
*/
public final Builder classes(List list) {
this.classes = _listAddAll(this.classes, list);
return this;
}
/**
* Required - If the trained model is a classification model, feature importance
* statistics are gathered per target class value.
*
* API name: {@code classes}
*
* Adds one or more values to classes.
*/
public final Builder classes(TotalFeatureImportanceClass value, TotalFeatureImportanceClass... values) {
this.classes = _listAdd(this.classes, value, values);
return this;
}
/**
* Required - If the trained model is a classification model, feature importance
* statistics are gathered per target class value.
*
* API name: {@code classes}
*
* Adds a value to classes using a builder lambda.
*/
public final Builder classes(
Function> fn) {
return classes(fn.apply(new TotalFeatureImportanceClass.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link TotalFeatureImportance}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public TotalFeatureImportance build() {
_checkSingleUse();
return new TotalFeatureImportance(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link TotalFeatureImportance}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, TotalFeatureImportance::setupTotalFeatureImportanceDeserializer);
protected static void setupTotalFeatureImportanceDeserializer(
ObjectDeserializer op) {
op.add(Builder::featureName, JsonpDeserializer.stringDeserializer(), "feature_name");
op.add(Builder::importance, JsonpDeserializer.arrayDeserializer(TotalFeatureImportanceStatistics._DESERIALIZER),
"importance");
op.add(Builder::classes, JsonpDeserializer.arrayDeserializer(TotalFeatureImportanceClass._DESERIALIZER),
"classes");
}
}