Module org.elasticsearch.server
Package org.elasticsearch.indices

Record Class SystemIndexDescriptor.MappingsVersion

java.lang.Object
java.lang.Record
org.elasticsearch.indices.SystemIndexDescriptor.MappingsVersion
All Implemented Interfaces:
Comparable<SystemIndexDescriptor.MappingsVersion>, Writeable, ToXContent
Enclosing class:
SystemIndexDescriptor
public static record SystemIndexDescriptor.MappingsVersion(int version, int hash) extends Record implements Writeable, ToXContent, Comparable<SystemIndexDescriptor.MappingsVersion>
The version of the mapping, which should be stored as an int in a mapping metadata field. This will be used with prior index descriptors to determine which mappings should be used when creating a system index, and it will be used to determine when mappings should be updated with the latest mappings from the system index descriptor. See SystemIndexMappingUpdateService, TransportCreateIndexAction, and AutoCreateAction.

Version should be a non-negative integer for a managed index, or -1 for unmanaged indices. The hash is a hash of the system index descriptor's mappings so that we can warn in case of inconsistencies across nodes.

  • Constructor Details

    • MappingsVersion

      public MappingsVersion(StreamInput in) throws IOException
      Throws:
      IOException

    • MappingsVersion

      public MappingsVersion(int version, int hash)
      Creates an instance of a MappingsVersion record class.
      Parameters:
      version - the value for the version record component
      hash - the value for the hash record component

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toXContent

      public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      IOException

    • compareTo

      public int compareTo(SystemIndexDescriptor.MappingsVersion o)
      Specified by:
      compareTo in interface Comparable<SystemIndexDescriptor.MappingsVersion>

    • toString

      public final 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 '=='.
      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.

    • version

      public int version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • hash

      public int hash()
      Returns the value of the hash record component.
      Returns:
      the value of the hash record component