Package org.elasticsearch.xpack.esql.core.expression

Class TimeSeriesMetadataAttribute

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.NamedExpression

org.elasticsearch.xpack.esql.core.expression.Attribute

org.elasticsearch.xpack.esql.core.expression.TypedAttribute

org.elasticsearch.xpack.esql.core.expression.FieldAttribute

org.elasticsearch.xpack.esql.core.expression.TimeSeriesMetadataAttribute

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

public final class TimeSeriesMetadataAttribute
extends FieldAttribute

Field attribute for _timeseries field

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.FieldAttribute

FieldAttribute.FieldName

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

Attribute.IdIgnoringWrapper

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

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

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

Field Summary

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.FieldAttribute

ESQL_FIELD_ATTRIBUTE_DROP_TYPE, ESQL_TIMESERIES_METADATA_ATTRIBUTE, lazyFieldName

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

SYNTHETIC_ATTRIBUTE_NAME_PREFIX, SYNTHETIC_ATTRIBUTE_NAME_SEPARATOR

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
TimeSeriesMetadataAttribute(Source source, String parentName, String qualifier, String name, EsField field, Nullability nullability, NameId id, boolean synthetic, Set<String> withoutFields)
TimeSeriesMetadataAttribute(Source source, Set<String> withoutFields)

Method Summary

Modifier and Type	Method	Description
protected Attribute	clone(Source source, String qualifier, String name, DataType type, Nullability nullability, NameId id, boolean synthetic)
static TimeSeriesMetadataAttribute	from(Attribute attribute, Set<String> withoutFields)	Builds a _timeseries attribute from an existing attribute while preserving its identity.
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
protected boolean	innerEquals(Object o, boolean ignoreIds)	The actual equality check, after shortcutting this == o and class checks.
protected int	innerHashCode(boolean ignoreIds)
Set<String>	withoutFields()

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.FieldAttribute

checkUnresolved, exactAttribute, field, fieldName, getExactInfo, getWriteableName, isDimension, isMetric, label, name, nodeString, parentName, readFrom, timeSeriesAttribute, withDataType, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.TypedAttribute

dataType

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Attribute

canonicalize, checkAndSerializeQualifier, dataTypeEquals, ignoreId, nullable, qualifiedName, qualifier, rawTemporaryName, readQualifier, references, replaceChildren, semanticEquals, semanticHash, toAttribute, toString, withId, withLocation, withName, withNullability, withQualifier

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.NamedExpression

equals, equals, hashCode, hashCode, id, synthetic

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, childrenResolved, fold, foldable, propertiesToString, resolved, resolveType, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

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

Constructor Details

TimeSeriesMetadataAttribute

public TimeSeriesMetadataAttribute(Source source,
 Set<String> withoutFields)

TimeSeriesMetadataAttribute

public TimeSeriesMetadataAttribute(Source source,
 @Nullable
 String parentName,
 @Nullable
 String qualifier,
 String name,
 EsField field,
 Nullability nullability,
 @Nullable
 NameId id,
 boolean synthetic,
 Set<String> withoutFields)

Method Details

from

public static TimeSeriesMetadataAttribute from(Attribute attribute,
 Set<String> withoutFields)

Builds a _timeseries attribute from an existing attribute while preserving its identity.

withoutFields

public Set<String> withoutFields()

info

protected NodeInfo<? extends Expression> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Overrides:

info in class FieldAttribute

clone

protected Attribute clone(Source source,
 String qualifier,
 String name,
 DataType type,
 Nullability nullability,
 NameId id,
 boolean synthetic)

Overrides:

clone in class FieldAttribute

innerHashCode

protected int innerHashCode(boolean ignoreIds)

Overrides:

innerHashCode in class FieldAttribute

innerEquals

protected boolean innerEquals(Object o,
 boolean ignoreIds)

Description copied from class: NamedExpression

The actual equality check, after shortcutting this == o and class checks.

Overrides:

innerEquals in class FieldAttribute