Package co.elastic.clients.elasticsearch.ml

Class DataDescription

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataDescription

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DataDescription
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final String	fieldDelimiter()	API name: field_delimiter
final String	format()	Only JSON format is supported at this time.
static DataDescription	of(Function<DataDescription.Builder,ObjectBuilder<DataDescription>> fn)
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	setupDataDescriptionDeserializer(ObjectDeserializer<DataDescription.Builder> op)
final String	timeField()	The name of the field that contains the timestamp.
final String	timeFormat()	The time format, which can be epoch, epoch_ms, or a custom pattern.
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<DataDescription> _DESERIALIZER

Json deserializer for DataDescription

Method Details

of

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

format

@Nullable
public final String format()

Only JSON format is supported at this time.

API name: format

timeField

@Nullable
public final String timeField()

The name of the field that contains the timestamp.

API name: time_field

timeFormat

@Nullable
public final String timeFormat()

The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.

API name: time_format

fieldDelimiter

@Nullable
public final String fieldDelimiter()

API name: field_delimiter

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

setupDataDescriptionDeserializer

protected static void setupDataDescriptionDeserializer(ObjectDeserializer<DataDescription.Builder> op)