Package org.elasticsearch.xpack.esql.expression.function

Class UnsupportedAttribute

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.expression.function.UnsupportedAttribute

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, Unresolvable

public final class UnsupportedAttribute
extends FieldAttribute
implements Unresolvable

Unsupported attribute that has been found yet cannot be used except in special conditions (currently only in projections to allow it to flow through the engine). As such the field is marked as unresolved (so the verifier can pick up its usage outside project).

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 interface org.elasticsearch.common.io.stream.Writeable

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

Field Summary

Fields

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY
static final NamedWriteableRegistry.Entry	EXPRESSION_ENTRY
static final NamedWriteableRegistry.Entry	NAMED_EXPRESSION_ENTRY

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

ESQL_FIELD_ATTRIBUTE_DROP_TYPE, 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_WIDTH

Fields inherited from interface org.elasticsearch.xpack.esql.core.capabilities.Unresolvable

UNRESOLVED_PREFIX

Constructor Summary

Constructors

Constructor	Description
UnsupportedAttribute(Source source, String qualifier, String name, UnsupportedEsField field, String customMessage, NameId id)
UnsupportedAttribute(Source source, String name, UnsupportedEsField field)
UnsupportedAttribute(Source source, String name, UnsupportedEsField field, String customMessage)
UnsupportedAttribute(Source source, String name, UnsupportedEsField field, String customMessage, NameId id)

Method Summary

Modifier and Type	Method	Description
protected Attribute	clone(Source source, String qualifier, String name, DataType type, Nullability nullability, NameId id, boolean synthetic)
UnsupportedEsField	field()
FieldAttribute.FieldName	fieldName()	The full name of the field in the index, including all parent fields.
String	getWriteableName()
boolean	hasCustomMessage()
protected NodeInfo<FieldAttribute>	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)
protected String	label()
String	nodeString()
List<String>	originalTypes()	This contains all the underlying ES types.
static UnsupportedAttribute	readFrom(StreamInput in)
boolean	resolved()
String	toString()
String	unresolvedMessage()	NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.
void	writeTo(StreamOutput out)

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

exactAttribute, getExactInfo, isDimension, isMetric, name, parentName, withDataType

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, 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, resolveType, typeResolved

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

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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

NAMED_EXPRESSION_ENTRY

public static final NamedWriteableRegistry.Entry NAMED_EXPRESSION_ENTRY

EXPRESSION_ENTRY

public static final NamedWriteableRegistry.Entry EXPRESSION_ENTRY

Constructor Details

UnsupportedAttribute

public UnsupportedAttribute(Source source,
 String name,
 UnsupportedEsField field)

UnsupportedAttribute

public UnsupportedAttribute(Source source,
 String name,
 UnsupportedEsField field,
 @Nullable
 String customMessage)

UnsupportedAttribute

public UnsupportedAttribute(Source source,
 String name,
 UnsupportedEsField field,
 @Nullable
 String customMessage,
 @Nullable
 NameId id)

UnsupportedAttribute

public UnsupportedAttribute(Source source,
 @Nullable
 String qualifier,
 String name,
 UnsupportedEsField field,
 @Nullable
 String customMessage,
 @Nullable
 NameId id)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class FieldAttribute

Throws:

IOException

readFrom

public static UnsupportedAttribute readFrom(StreamInput in)
                                     throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Overrides:

getWriteableName in class FieldAttribute

resolved

public boolean resolved()

Specified by:

resolved in interface Resolvable

Specified by:

resolved in interface Unresolvable

Overrides:

resolved in class Expression

field

public UnsupportedEsField field()

Overrides:

field in class FieldAttribute

fieldName

public FieldAttribute.FieldName fieldName()

Description copied from class: FieldAttribute

The full name of the field in the index, including all parent fields. E.g. parent.subfield.this_field.

Overrides:

fieldName in class FieldAttribute

info

protected NodeInfo<FieldAttribute> 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

label

protected String label()

Overrides:

label in class FieldAttribute

toString

public String toString()

Overrides:

toString in class Attribute

nodeString

public String nodeString()

Overrides:

nodeString in class Attribute

unresolvedMessage

public String unresolvedMessage()

Description copied from interface: Unresolvable

NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.

Specified by:

unresolvedMessage in interface Unresolvable

hasCustomMessage

public boolean hasCustomMessage()

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

originalTypes

public List<String> originalTypes()

This contains all the underlying ES types. On a type conflict this will have many elements, some or all of which may be actually supported types.