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.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

lazyFieldName

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

SYNTHETIC_ATTRIBUTE_NAME_PREFIX

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 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 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.
int	hashCode()
protected NodeInfo<FieldAttribute>	info()	Return the information about this node.
protected boolean	innerEquals(Object o)
Set<String>	withoutFields()

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

exactAttribute, field, fieldName, getExactInfo, getWriteableName, 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, nullable, originalTypes, rawTemporaryName, references, replaceChildren, semanticEquals, semanticHash, toAttribute, toString, withId, withLocation, withName, withNullability

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

equals, 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

anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, 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,
 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<FieldAttribute> info()

Description copied from class: Node

Return the information about this 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 of 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 name,
 DataType type,
 Nullability nullability,
 NameId id,
 boolean synthetic)

Overrides:

clone in class FieldAttribute

hashCode

public int hashCode()

Overrides:

hashCode in class FieldAttribute

innerEquals

protected boolean innerEquals(Object o)

Overrides:

innerEquals in class FieldAttribute