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

Class KeywordEsField

java.lang.Object

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

org.elasticsearch.xpack.esql.core.type.KeywordEsField

All Implemented Interfaces:

Writeable

Direct Known Subclasses:

PotentiallyUnmappedKeywordEsField

public class KeywordEsField
extends EsField

Information about a field in an ES index with the keyword type.

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

Modifier	Constructor	Description
	KeywordEsField(String name, Map<String,EsField> properties, boolean hasDocValues, int precision, boolean normalized, boolean isAlias, EsField.TimeSeriesFieldType timeSeriesFieldType)
protected	KeywordEsField(String name, DataType esDataType, Map<String,EsField> properties, boolean hasDocValues, int precision, boolean normalized, boolean isAlias, EsField.TimeSeriesFieldType timeSeriesFieldType)
	KeywordEsField(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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
boolean	getNormalized()
int	getPrecision()
String	getWriteableName(TransportVersion transportVersion)	This needs to be overridden by subclasses for specific serialization
int	hashCode()
void	writeContent(StreamOutput out)	This needs to be overridden by subclasses for specific serialization

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

getDataType, getExactField, getName, getNodeStringName, getProperties, getReader, getTimeSeriesFieldType, isAggregatable, isAlias, readFrom, readTimeSeriesFieldType, toString, withDataType, withWidenedSmallNumeric, writeTimeSeriesFieldType, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

KeywordEsField

public KeywordEsField(String name,
 Map<String,EsField> properties,
 boolean hasDocValues,
 int precision,
 boolean normalized,
 boolean isAlias,
 EsField.TimeSeriesFieldType timeSeriesFieldType)

KeywordEsField

protected KeywordEsField(String name,
 DataType esDataType,
 Map<String,EsField> properties,
 boolean hasDocValues,
 int precision,
 boolean normalized,
 boolean isAlias,
 EsField.TimeSeriesFieldType timeSeriesFieldType)

KeywordEsField

public KeywordEsField(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

writeContent

public void writeContent(StreamOutput out)
                  throws IOException

Description copied from class: EsField

This needs to be overridden by subclasses for specific serialization

Overrides:

writeContent in class EsField

Throws:

IOException

getWriteableName

public String getWriteableName(TransportVersion transportVersion)

Description copied from class: EsField

This needs to be overridden by subclasses for specific serialization

Overrides:

getWriteableName in class EsField

getPrecision

public int getPrecision()

getNormalized

public boolean getNormalized()

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

equals

public boolean equals(Object o)

Overrides:

equals in class EsField

hashCode

public int hashCode()

Overrides:

hashCode in class EsField