Package dev.vortex.spark.write

Record Class VortexWriterCommitMessage

java.lang.Object
java.lang.Record
dev.vortex.spark.write.VortexWriterCommitMessage
All Implemented Interfaces:
Serializable, org.apache.spark.sql.connector.write.WriterCommitMessage
public record VortexWriterCommitMessage(String filePath, long recordCount, long bytesWritten) extends Record implements org.apache.spark.sql.connector.write.WriterCommitMessage, Serializable
Commit message containing information about a successfully written Vortex file.

This message is passed from executors back to the driver to coordinate the commit phase of the write operation.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    VortexWriterCommitMessage(String filePath, long recordCount, long bytesWritten)
    Creates a new commit message for a written Vortex file.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    bytesWritten()
    Gets the number of bytes written to the file.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    filePath()
    Gets the path to the written Vortex file.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    recordCount()
    Gets the number of records written to the file.
    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

    • VortexWriterCommitMessage

      public VortexWriterCommitMessage(String filePath, long recordCount, long bytesWritten)
      Creates a new commit message for a written Vortex file.
      Parameters:
      filePath - the path to the written file
      recordCount - the number of records written
      bytesWritten - the number of bytes written

  • Method Details

    • filePath

      public String filePath()
      Gets the path to the written Vortex file.
      Returns:
      the file path

    • recordCount

      public long recordCount()
      Gets the number of records written to the file.
      Returns:
      the record count

    • bytesWritten

      public long bytesWritten()
      Gets the number of bytes written to the file.
      Returns:
      the byte count

    • 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.