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

Class FunctionEsField

java.lang.Object

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

org.elasticsearch.xpack.esql.core.type.FunctionEsField

All Implemented Interfaces:

Writeable

public class FunctionEsField
extends EsField

EsField that represents a function being applied to a field on extraction. It receives a BlockLoaderFunctionConfig that will be passed down to the block loading process to apply the function at data load time.

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
FunctionEsField(EsField esField, DataType dataType, BlockLoaderFunctionConfig functionConfig)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BlockLoaderFunctionConfig	functionConfig()
EsField.Exact	getExactInfo()	Returns and EsField.Exact object with all the necessary info about the field: If it has an exact underlying field or not and if not an error message why it doesn't
int	hashCode()
void	writeTo(StreamOutput out)

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

getDataType, getExactField, getName, getProperties, getReader, getTimeSeriesFieldType, getWriteableName, isAggregatable, isAlias, readFrom, readTimeSeriesFieldType, toString, writeContent, writeTimeSeriesFieldType

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionEsField

public FunctionEsField(EsField esField,
 DataType dataType,
 BlockLoaderFunctionConfig functionConfig)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class EsField

Throws:

IOException

functionConfig

public BlockLoaderFunctionConfig functionConfig()

equals

public boolean equals(Object o)

Overrides:

equals in class EsField

hashCode

public int hashCode()

Overrides:

hashCode in class EsField

getExactInfo

public EsField.Exact getExactInfo()

Description copied from class: EsField

Returns and EsField.Exact object with all the necessary info about the field:

• If it has an exact underlying field or not
• and if not an error message why it doesn't

Overrides:

getExactInfo in class EsField