Package co.elastic.clients.elasticsearch.esql

Class DatasetFieldMapping

java.lang.Object

co.elastic.clients.elasticsearch.esql.DatasetFieldMapping

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DatasetFieldMapping
extends Object
implements JsonpSerializable

A per-column declaration inside a dataset mapping's properties.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final String	format()	The date-parse pattern for a declared date column, mirroring the index date-field format.
static DatasetFieldMapping	of(Function<DatasetFieldMapping.Builder,ObjectBuilder<DatasetFieldMapping>> fn)
final String	path()	The underlying file column that this logical column reads from.
DatasetFieldMapping.Builder	rebuild()
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	setupDatasetFieldMappingDeserializer(ObjectDeserializer<DatasetFieldMapping.Builder> op)
String	toString()
final String	type()	Required - The declared column type.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DatasetFieldMapping> _DESERIALIZER

Json deserializer for DatasetFieldMapping

Method Details

of

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

type

public final String type()

Required - The declared column type.

API name: type

path

@Nullable
public final String path()

The underlying file column that this logical column reads from. This is a read-path rename: the physical column becomes this single logical column.

API name: path

format

@Nullable
public final String format()

The date-parse pattern for a declared date column, mirroring the index date-field format.

API name: format

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

rebuild

public DatasetFieldMapping.Builder rebuild()

Returns:

New DatasetFieldMapping.Builder initialized with field values of this instance

setupDatasetFieldMappingDeserializer

protected static void setupDatasetFieldMappingDeserializer(ObjectDeserializer<DatasetFieldMapping.Builder> op)