Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.job.config

Class DataDescription

java.lang.Object

org.elasticsearch.xpack.core.ml.job.config.DataDescription

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class DataDescription
extends Object
implements ToXContentObject, Writeable

Describes the format of the data used in the job and how it should be interpreted by autodetect.

Data must either be in JSON or SMILE format (and only JSON is publicly documented). The DataDescription.DataFormat enum is always set to XCONTENT. getTimeField() is the name of the field containing the timestamp and getTimeFormat() is the format code for the date string in as described by DateTimeFormatter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataDescription.Builder
static enum	DataDescription.DataFormat	Enum of the acceptable data formats.

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	DATA_DESCRIPTION_FIELD
static final String	DEFAULT_TIME_FIELD	By default autodetect expects the timestamp in a field with this name
static final String	EPOCH	Special time format string for epoch times (seconds)
static final String	EPOCH_MS	Special time format string for epoch times (milli-seconds)
static final ParseField	FORMAT_FIELD
static final ObjectParser<DataDescription.Builder,Void>	LENIENT_PARSER
static final ObjectParser<DataDescription.Builder,Void>	STRICT_PARSER
static final ParseField	TIME_FIELD_NAME_FIELD
static final ParseField	TIME_FORMAT_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataDescription(String timeFieldName, String timeFormat)
DataDescription(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)	Overridden equality test
String	getTimeField()	The name of the field containing the timestamp
String	getTimeFormat()	Either "epoch", "epoch_ms" or a SimpleDateTime format string.
int	hashCode()
boolean	isEpochMs()	Return true if the time format is "epoch_ms"
boolean	isTransformTime()	Return true if the time is in a format that needs transforming.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

DATA_DESCRIPTION_FIELD

public static final ParseField DATA_DESCRIPTION_FIELD

FORMAT_FIELD

public static final ParseField FORMAT_FIELD

TIME_FIELD_NAME_FIELD

public static final ParseField TIME_FIELD_NAME_FIELD

TIME_FORMAT_FIELD

public static final ParseField TIME_FORMAT_FIELD

EPOCH

public static final String EPOCH

Special time format string for epoch times (seconds)

See Also:

• Constant Field Values

EPOCH_MS

public static final String EPOCH_MS

Special time format string for epoch times (milli-seconds)

See Also:

• Constant Field Values

DEFAULT_TIME_FIELD

public static final String DEFAULT_TIME_FIELD

By default autodetect expects the timestamp in a field with this name

See Also:

• Constant Field Values

LENIENT_PARSER

public static final ObjectParser<DataDescription.Builder,Void> LENIENT_PARSER

STRICT_PARSER

public static final ObjectParser<DataDescription.Builder,Void> STRICT_PARSER

Constructor Details

DataDescription

public DataDescription(String timeFieldName,
 String timeFormat)

DataDescription

public DataDescription(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getTimeField

public String getTimeField()

The name of the field containing the timestamp

Returns:

A String if set or null

getTimeFormat

public String getTimeFormat()

Either "epoch", "epoch_ms" or a SimpleDateTime format string. If not set (is null or an empty string) or set to "epoch_ms" (the default) then the date is assumed to be in milliseconds from the epoch.

Returns:

A String if set or null

isTransformTime

public boolean isTransformTime()

Return true if the time is in a format that needs transforming. Anytime format this isn't "epoch" or null needs transforming.

Returns:

True if the time field needs to be transformed.

isEpochMs

public boolean isEpochMs()

Return true if the time format is "epoch_ms"

Returns:

True if the date is in milli-seconds since the epoch.

equals

public boolean equals(Object other)

Overridden equality test

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object