Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalyticsFieldSelection

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataframeAnalyticsFieldSelection

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DataframeAnalyticsFieldSelection
extends Object
implements JsonpSerializable

See Also:

• API specification

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 final JsonpDeserializer<DataframeAnalyticsFieldSelection>	_DESERIALIZER	Json deserializer for DataframeAnalyticsFieldSelection

Method Summary

Modifier and Type	Method	Description
final String	featureType()	The feature type of this field for the analysis.
final boolean	isIncluded()	Required - Whether the field is selected to be included in the analysis.
final boolean	isRequired()	Required - Whether the field is required.
final List<String>	mappingTypes()	Required - The mapping types of the field.
final String	name()	Required - The field name.
static DataframeAnalyticsFieldSelection	of(Function<DataframeAnalyticsFieldSelection.Builder,ObjectBuilder<DataframeAnalyticsFieldSelection>> fn)
final 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(ObjectDeserializer<DataframeAnalyticsFieldSelection.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DataframeAnalyticsFieldSelection> _DESERIALIZER

Json deserializer for DataframeAnalyticsFieldSelection

Method Details

of

public static DataframeAnalyticsFieldSelection of(Function<DataframeAnalyticsFieldSelection.Builder,ObjectBuilder<DataframeAnalyticsFieldSelection>> fn)

isIncluded

public final boolean isIncluded()

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

API name: is_included

isRequired

public final boolean isRequired()

Required - Whether the field is required.

API name: is_required

featureType

@Nullable
public final String featureType()

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

API name: feature_type

mappingTypes

public final List<String> mappingTypes()

Required - The mapping types of the field.

API name: mapping_types

name

public final String name()

Required - The field name.

API name: name

reason

@Nullable
public final 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)

toString

public String toString()

Overrides:

toString in class Object

setupDataframeAnalyticsFieldSelectionDeserializer

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