Class TextEsField

java.lang.Object
org.elasticsearch.xpack.esql.core.type.EsField
org.elasticsearch.xpack.esql.core.type.TextEsField
All Implemented Interfaces:
Writeable

public class TextEsField extends EsField
Information about a field in an es index with the text type.
  • Constructor Details

  • 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()
      Description copied from class: EsField
      This needs to be overridden by subclasses for specific serialization
      Overrides:
      getWriteableName in class EsField
    • getExactField

      public EsField getExactField()
      Description copied from class: EsField
      Returns 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 exception EsField.getExactInfo() should be used beforehand, to check if an exact field exists and if not get the errorMessage which explains why is that.
      Overrides:
      getExactField 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