Record Class EsIndex

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.index.EsIndex
All Implemented Interfaces:
Writeable

public record EsIndex(String name, Map<String,EsField> mapping, Map<String,IndexMode> indexNameWithModes, Set<String> partiallyUnmappedFields) extends Record implements Writeable
  • Constructor Details

    • EsIndex

      public EsIndex(String name, Map<String,EsField> mapping, Map<String,IndexMode> indexNameWithModes, Set<String> partiallyUnmappedFields)
      Creates an instance of a EsIndex record class.
      Parameters:
      name - the value for the name record component
      mapping - the value for the mapping record component
      indexNameWithModes - the value for the indexNameWithModes record component
      partiallyUnmappedFields - the value for the partiallyUnmappedFields record component
    • EsIndex

      public EsIndex(String name, Map<String,EsField> mapping, Map<String,IndexMode> indexNameWithModes)
    • EsIndex

      public EsIndex(String name, Map<String,EsField> mapping)
      Intended for tests. Returns an index with an empty index mode map.
  • Method Details

    • readFrom

      public static EsIndex readFrom(StreamInput in) throws IOException
      Throws:
      IOException
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • isPartiallyUnmappedField

      public boolean isPartiallyUnmappedField(String fieldName)
    • concreteIndices

      public Set<String> concreteIndices()
    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component
    • mapping

      public Map<String,EsField> mapping()
      Returns the value of the mapping record component.
      Returns:
      the value of the mapping record component
    • indexNameWithModes

      public Map<String,IndexMode> indexNameWithModes()
      Returns the value of the indexNameWithModes record component.
      Returns:
      the value of the indexNameWithModes record component
    • partiallyUnmappedFields

      public Set<String> partiallyUnmappedFields()
      Returns the value of the partiallyUnmappedFields record component.
      Returns:
      the value of the partiallyUnmappedFields record component