Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalyticsFieldSelection

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataframeAnalyticsFieldSelection

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public final class DataframeAnalyticsFieldSelection
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataframeAnalyticsFieldSelection.Builder	Builder for DataframeAnalyticsFieldSelection.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<DataframeAnalyticsFieldSelection>	_DESERIALIZER	Json deserializer for DataframeAnalyticsFieldSelection

Constructor Summary

Constructors

Constructor	Description
DataframeAnalyticsFieldSelection(DataframeAnalyticsFieldSelection.Builder builder)
DataframeAnalyticsFieldSelection(java.util.function.Function<DataframeAnalyticsFieldSelection.Builder,DataframeAnalyticsFieldSelection.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	featureType()	The feature type of this field for the analysis.
boolean	isIncluded()	Required - Whether the field is selected to be included in the analysis.
boolean	isRequired()	Required - Whether the field is required.
java.util.List<java.lang.String>	mappingTypes()	Required - The mapping types of the field.
java.lang.String	name()	Required - The field name.
java.lang.String	reason()	The reason a field is not selected to be included in the analysis.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDataframeAnalyticsFieldSelectionDeserializer(DelegatingDeserializer<DataframeAnalyticsFieldSelection.Builder> op)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DataframeAnalyticsFieldSelection> _DESERIALIZER

Json deserializer for DataframeAnalyticsFieldSelection

Constructor Details

DataframeAnalyticsFieldSelection

public DataframeAnalyticsFieldSelection(DataframeAnalyticsFieldSelection.Builder builder)

DataframeAnalyticsFieldSelection

public DataframeAnalyticsFieldSelection(java.util.function.Function<DataframeAnalyticsFieldSelection.Builder,DataframeAnalyticsFieldSelection.Builder> fn)

Method Details

isIncluded

public boolean isIncluded()

Required - Whether the field is selected to be included in the analysis.

API name: is_included

isRequired

public boolean isRequired()

Required - Whether the field is required.

API name: is_required

featureType

@Nullable
public java.lang.String featureType()

The feature type of this field for the analysis. May be categorical or numerical.

API name: feature_type

mappingTypes

public java.util.List<java.lang.String> mappingTypes()

Required - The mapping types of the field.

API name: mapping_types

name

public java.lang.String name()

Required - The field name.

API name: name

reason

@Nullable
public java.lang.String reason()

The reason a field is not selected to be included in the analysis.

API name: reason

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

setupDataframeAnalyticsFieldSelectionDeserializer

protected static void setupDataframeAnalyticsFieldSelectionDeserializer(DelegatingDeserializer<DataframeAnalyticsFieldSelection.Builder> op)