Package org.elasticsearch.xpack.esql.datasources.cache

Record Class FooterByteCache.Key

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.datasources.cache.FooterByteCache.Key
Enclosing class:
FooterByteCache
public static record FooterByteCache.Key(String path, long fileLength) extends Record
Cache key identifying a file by its storage path and total length. Uses (path, length) only — not lastModified — so that all range splits of the same file share one cache entry regardless of any timing jitter in StorageObject.lastModified().

  • Constructor Summary

    Constructors
    Constructor
    Description
    Key(String path, long fileLength)
    Creates an instance of a Key record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    fileLength()
    Returns the value of the fileLength record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    static FooterByteCache.Key
    keyFor(StorageObject storageObject, long length)
    Creates a key from a StorageObject, using its path string as the canonical identifier.
    String
    path()
    Returns the value of the path record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Key

      public Key(String path, long fileLength)
      Creates an instance of a Key record class.
      Parameters:
      path - the value for the path record component
      fileLength - the value for the fileLength record component

  • Method Details

    • keyFor

      public static FooterByteCache.Key keyFor(StorageObject storageObject, long length)
      Creates a key from a StorageObject, using its path string as the canonical identifier. All callers should prefer this factory over constructing Key directly so that path canonicalization happens in one place.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • path

      public String path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component

    • fileLength

      public long fileLength()
      Returns the value of the fileLength record component.
      Returns:
      the value of the fileLength record component