Package com.qtsurfer.api.client.model

Class LiveRunStats

java.lang.Object
com.qtsurfer.api.client.model.LiveRunStats
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class LiveRunStats extends Object
What a run has been doing, as of its last snapshot. The platform refreshes it about once a minute while the run is being executed, so `opsPerSecond` is an average over that interval, not an instantaneous rate.

  • Field Details

  • Constructor Details

    • LiveRunStats

      public LiveRunStats()

  • Method Details

    • processed

      public LiveRunStats processed(@Nonnull Long processed)

    • getProcessed

      @Nonnull public Long getProcessed()
      Updates of instruments the run has accepted since it started executing. It can start again from zero if the run is restarted.
      Returns:
      processed

    • setProcessed

      public void setProcessed(@Nonnull Long processed)

    • opsPerSecond

      public LiveRunStats opsPerSecond(@Nonnull BigDecimal opsPerSecond)

    • getOpsPerSecond

      @Nonnull public BigDecimal getOpsPerSecond()
      Updates accepted per second over the last refresh interval. `0` when none arrived.
      Returns:
      opsPerSecond

    • setOpsPerSecond

      public void setOpsPerSecond(@Nonnull BigDecimal opsPerSecond)

    • instrumentsSeen

      public LiveRunStats instrumentsSeen(@Nonnull Integer instrumentsSeen)

    • getInstrumentsSeen

      @Nonnull public Integer getInstrumentsSeen()
      How many distinct instruments the run has received an update for.
      Returns:
      instrumentsSeen

    • setInstrumentsSeen

      public void setInstrumentsSeen(@Nonnull Integer instrumentsSeen)

    • asOfMs

      public LiveRunStats asOfMs(@Nonnull Long asOfMs)

    • getAsOfMs

      @Nonnull public Long getAsOfMs()
      Epoch milliseconds when these counters were last written.
      Returns:
      asOfMs

    • setAsOfMs

      public void setAsOfMs(@Nonnull Long asOfMs)

    • progressedAtMs

      public LiveRunStats progressedAtMs(@Nullable Long progressedAtMs)

    • getProgressedAtMs

      @Nullable public Long getProgressedAtMs()
      Epoch milliseconds of the last snapshot in which `processed` had grown. Absent until the run has processed anything. A run fed by a source that updates rarely (a funding rate, for example) can stay flat for hours: that is how such a run behaves, not a fault.
      Returns:
      progressedAtMs

    • setProgressedAtMs

      public void setProgressedAtMs(@Nullable Long progressedAtMs)

    • stale

      public LiveRunStats stale(@Nonnull Boolean stale)

    • getStale

      @Nonnull public Boolean getStale()
      `true` when the run is meant to be running (`desired` is `RUNNING`) and its counters have not been refreshed for several refresh intervals: the platform has stopped updating them, which is worth checking against `state`. `false` otherwise. A run whose `processed` is flat is not stale; `progressedAtMs` is how to tell it apart.
      Returns:
      stale

    • setStale

      public void setStale(@Nonnull Boolean stale)

    • equals

      public boolean equals(Object o)
      Return true if this LiveRunStats object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string