Package co.elastic.clients.elasticsearch.ml

Enum Class Include

java.lang.Object

java.lang.Enum<Include>

co.elastic.clients.elasticsearch.ml.Include

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<Include>, Constable

@JsonpDeserializable
public enum Include
extends Enum<Include>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Definition	Includes the model definition.
FeatureImportanceBaseline	Includes the baseline for feature importance values.
Hyperparameters	Includes the information about hyperparameters used to train the model.
TotalFeatureImportance	Includes the total feature importance for the training data set.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<Include>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static Include	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Include[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

Definition

public static final Include Definition

Includes the model definition.

FeatureImportanceBaseline

public static final Include FeatureImportanceBaseline

Includes the baseline for feature importance values.

Hyperparameters

public static final Include Hyperparameters

Includes the information about hyperparameters used to train the model. This information consists of the value, the absolute and relative importance of the hyperparameter as well as an indicator of whether it was specified by the user or tuned during hyperparameter optimization.

TotalFeatureImportance

public static final Include TotalFeatureImportance

Includes the total feature importance for the training data set. The baseline and total feature importance values are returned in the metadata field in the response body.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<Include> _DESERIALIZER

Method Details

values

public static Include[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Include valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum