Package org.elasticsearch.xpack.esql.core.type

Class UnionTypeEsField

java.lang.Object

org.elasticsearch.xpack.esql.core.type.EsField

org.elasticsearch.xpack.esql.core.type.UnionTypeEsField

All Implemented Interfaces:

Writeable

Direct Known Subclasses:

CompactMultiTypeEsField, MultiTypeEsField

public abstract sealed class UnionTypeEsField
extends EsField
permits MultiTypeEsField, CompactMultiTypeEsField

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.type.EsField

EsField.Exact, EsField.TimeSeriesFieldType

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

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

Constructor Summary

Constructors

Constructor	Description
UnionTypeEsField(String name, DataType esDataType, Map<String,EsField> properties, boolean aggregatable, EsField.TimeSeriesFieldType timeSeriesFieldType)

Method Summary

Modifier and Type	Method	Description
abstract Collection<Expression>	getConversionExpressions()
abstract Expression	getUnmappedConversionExpression()	Conversion expression to apply when the field is unmapped in the index (treating it as DataType.KEYWORD) or null if there is no such conversion (i.e., unmapped indices should produce null).
abstract UnionTypeEsField	rewrapWithCast(Expression convertExpression)	Wraps an existing union-type field's per-(index|type) conversions with another conversion expression on top, so the composite expression first does the original cast then the additional cast.
abstract UnionTypeEsField	withPotentiallyUnmappedExpression(Expression unmappedExpression)	Returns a copy of this field with the given unmapped conversion expression.

Methods inherited from class org.elasticsearch.xpack.esql.core.type.EsField

equals, getDataType, getExactField, getExactInfo, getName, getNodeStringName, getProperties, getReader, getTimeSeriesFieldType, getWriteableName, hashCode, isAggregatable, isAlias, readFrom, readTimeSeriesFieldType, toString, withDataType, withWidenedSmallNumeric, writeContent, writeTimeSeriesFieldType, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

UnionTypeEsField

public UnionTypeEsField(String name,
 DataType esDataType,
 Map<String,EsField> properties,
 boolean aggregatable,
 EsField.TimeSeriesFieldType timeSeriesFieldType)

Method Details

getUnmappedConversionExpression

@Nullable
public abstract Expression getUnmappedConversionExpression()

Conversion expression to apply when the field is unmapped in the index (treating it as DataType.KEYWORD) or null if there is no such conversion (i.e., unmapped indices should produce null).

getConversionExpressions

public abstract Collection<Expression> getConversionExpressions()

rewrapWithCast

public abstract UnionTypeEsField rewrapWithCast(Expression convertExpression)

Wraps an existing union-type field's per-(index|type) conversions with another conversion expression on top, so the composite expression first does the original cast then the additional cast.

withPotentiallyUnmappedExpression

public abstract UnionTypeEsField withPotentiallyUnmappedExpression(Expression unmappedExpression)

Returns a copy of this field with the given unmapped conversion expression.