Record Class CheckpointSavedEvent

java.lang.Object
java.lang.Record
com.knezevic.edaf.v3.core.events.CheckpointSavedEvent
All Implemented Interfaces:
RunEvent
public record CheckpointSavedEvent(String runId, Instant timestamp, int iteration, String checkpointPath) extends Record implements RunEvent
Event emitted when a checkpoint is persisted.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckpointSavedEvent(String runId, Instant timestamp, int iteration, String checkpointPath)
    Creates an instance of a CheckpointSavedEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    checkpointPath()
    Returns the value of the checkpointPath record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    iteration()
    Returns the value of the iteration record component.
    String
    runId()
    Returns the value of the runId record component.
    Instant
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
    Event type for structured logging.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CheckpointSavedEvent

      public CheckpointSavedEvent(String runId, Instant timestamp, int iteration, String checkpointPath)
      Creates an instance of a CheckpointSavedEvent record class.
      Parameters:
      runId - the value for the runId record component
      timestamp - the value for the timestamp record component
      iteration - the value for the iteration record component
      checkpointPath - the value for the checkpointPath record component

  • Method Details

    • type

      public String type()
      Description copied from interface: RunEvent
      Event type for structured logging.
      Specified by:
      type in interface RunEvent

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • runId

      public String runId()
      Returns the value of the runId record component.
      Specified by:
      runId in interface RunEvent
      Returns:
      the value of the runId record component

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface RunEvent
      Returns:
      the value of the timestamp record component

    • iteration

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

    • checkpointPath

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