Class TextEsField
java.lang.Object
org.elasticsearch.xpack.esql.core.type.EsField
org.elasticsearch.xpack.esql.core.type.TextEsField
- All Implemented Interfaces:
Writeable
Information about a field in an es index with the
text type.-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.type.EsField
EsField.ExactNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Constructor Summary
ConstructorsModifierConstructorDescriptionTextEsField(String name, Map<String, EsField> properties, boolean hasDocValues) TextEsField(String name, Map<String, EsField> properties, boolean hasDocValues, boolean isAlias) protected -
Method Summary
Modifier and TypeMethodDescriptionReturns the path to the keyword version of this field if this field is text and it has a subfield that is indexed as keyword, throws an exception if such field is not found or the field name itself in all other cases.Returns andEsField.Exactobject 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'tThis needs to be overridden by subclasses for specific serializationvoidwriteContent(StreamOutput out) This needs to be overridden by subclasses for specific serializationMethods inherited from class org.elasticsearch.xpack.esql.core.type.EsField
equals, getDataType, getName, getProperties, getReader, hashCode, isAggregatable, isAlias, readFrom, toString, writeTo
-
Constructor Details
-
TextEsField
-
TextEsField
-
TextEsField
- Throws:
IOException
-
-
Method Details
-
writeContent
Description copied from class:EsFieldThis needs to be overridden by subclasses for specific serialization- Overrides:
writeContentin classEsField- Throws:
IOException
-
getWriteableName
Description copied from class:EsFieldThis needs to be overridden by subclasses for specific serialization- Overrides:
getWriteableNamein classEsField
-
getExactField
Description copied from class:EsFieldReturns the path to the keyword version of this field if this field is text and it has a subfield that is indexed as keyword, throws an exception if such field is not found or the field name itself in all other cases. To avoid the exceptionEsField.getExactInfo()should be used beforehand, to check if an exact field exists and if not get the errorMessage which explains why is that.- Overrides:
getExactFieldin classEsField
-
getExactInfo
Description copied from class:EsFieldReturns andEsField.Exactobject 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:
getExactInfoin classEsField
-