Record Class BacktestProgress

java.lang.Object
java.lang.Record
com.qtsurfer.api.sdk.BacktestProgress
Record Components:
stage - current workflow stage
percent - 0-100 when the job exposes size information; null for stage transitions before the first poll.
coverageRatio - fraction (0-1) of the requested prepare window that actually holds data, as reported by the backend once preparation completes. Non-null only on the final BacktestStage.PREPARING event; null otherwise.

public record BacktestProgress(BacktestStage stage, Double percent, Double coverageRatio) extends Record
Emitted at stage transitions and after each poll with known size.
  • Constructor Details

    • BacktestProgress

      public BacktestProgress(BacktestStage stage, Double percent)
      Convenience form without coverage; coverageRatio defaults to null.
    • BacktestProgress

      public BacktestProgress(BacktestStage stage, Double percent, Double coverageRatio)
      Creates an instance of a BacktestProgress record class.
      Parameters:
      stage - the value for the stage record component
      percent - the value for the percent record component
      coverageRatio - the value for the coverageRatio record component
  • Method Details

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

      public BacktestStage stage()
      Returns the value of the stage record component.
      Returns:
      the value of the stage record component
    • percent

      public Double percent()
      Returns the value of the percent record component.
      Returns:
      the value of the percent record component
    • coverageRatio

      public Double coverageRatio()
      Returns the value of the coverageRatio record component.
      Returns:
      the value of the coverageRatio record component