Package com.qtsurfer.api.client.model

Class SweepProgress

java.lang.Object
com.qtsurfer.api.client.model.SweepProgress
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class SweepProgress extends Object
How far along a sweep is, and — when the sweep is still running — enough to tell a healthy one from a stuck one. The counts partition the shards (or, for a walk-forward sweep, the folds): every unit is either finished, failed, waiting to be retried, or not yet started.

  • Field Details

  • Constructor Details

    • SweepProgress

      public SweepProgress()

  • Method Details

    • done

      public SweepProgress done(@Nonnull Long done)

    • getDone

      @Nonnull public Long getDone()
      Get done
      Returns:
      done

    • setDone

      public void setDone(@Nonnull Long done)

    • total

      public SweepProgress total(@Nonnull Integer total)

    • getTotal

      @Nonnull public Integer getTotal()
      Get total
      Returns:
      total

    • setTotal

      public void setTotal(@Nonnull Integer total)

    • aborted

      public SweepProgress aborted(@Nonnull Long aborted)

    • getAborted

      @Nonnull public Long getAborted()
      Individual runs that executed and aborted. A row-level count: a shard that fails before producing any rows leaves this at 0, which is why `failedShards` exists alongside it.
      Returns:
      aborted

    • setAborted

      public void setAborted(@Nonnull Long aborted)

    • shardCount

      public SweepProgress shardCount(@Nonnull Integer shardCount)

    • getShardCount

      @Nonnull public Integer getShardCount()
      Get shardCount
      Returns:
      shardCount

    • setShardCount

      public void setShardCount(@Nonnull Integer shardCount)

    • pendingShards

      public SweepProgress pendingShards(@Nonnull Integer pendingShards)

    • getPendingShards

      @Nonnull public Integer getPendingShards()
      Get pendingShards
      Returns:
      pendingShards

    • setPendingShards

      public void setPendingShards(@Nonnull Integer pendingShards)

    • failedShards

      public SweepProgress failedShards(@Nonnull Long failedShards)

    • getFailedShards

      @Nonnull public Long getFailedShards()
      Shards (or folds) that failed and will not be retried. Distinct from `aborted`: this counts whole units that never reported, not runs that ran badly.
      Returns:
      failedShards

    • setFailedShards

      public void setFailedShards(@Nonnull Long failedShards)

    • retrying

      public SweepProgress retrying(@Nonnull Integer retrying)

    • getRetrying

      @Nonnull public Integer getRetrying()
      Units whose last attempt failed on something transient — an I/O error, a worker that died mid-read — and which are queued to be attempted again. Not counted as failures, because they have not failed yet; a sweep with a non-zero value here is still expected to complete.
      Returns:
      retrying

    • setRetrying

      public void setRetrying(@Nonnull Integer retrying)

    • notStarted

      public SweepProgress notStarted(@Nonnull Integer notStarted)

    • getNotStarted

      @Nonnull public Integer getNotStarted()
      Units that have not reported anything yet. Covers both work still queued behind other work and work claimed by a worker that stopped before it began, which is why a sweep with a persistent value here and a rising `stalledSeconds` is worth looking at.
      Returns:
      notStarted

    • setNotStarted

      public void setNotStarted(@Nonnull Integer notStarted)

    • stalledSeconds

      public SweepProgress stalledSeconds(@Nullable Long stalledSeconds)

    • getStalledSeconds

      @Nullable public Long getStalledSeconds()
      Seconds since anything last advanced. Omitted on a finished sweep, where it would only measure how long ago it finished, and on sweeps submitted before this field existed.
      Returns:
      stalledSeconds

    • setStalledSeconds

      public void setStalledSeconds(@Nullable Long stalledSeconds)

    • etaSeconds

      public SweepProgress etaSeconds(@Nullable Long etaSeconds)

    • getEtaSeconds

      @Nullable public Long getEtaSeconds()
      Rough seconds remaining, extrapolated from the rate observed so far and assuming nothing else competes for workers. Runs conservative in practice — it has measured 2–5× long when a sweep spent part of its life waiting to be retried, since that wait dilutes the observed rate. **Omitted, never zero, when it cannot be computed**: a sweep with nothing finished yet has no rate to extrapolate from, and a zero would read as \"about to finish\". Excludes queue wait entirely; `retrying` and `stalledSeconds` are where that shows up.
      Returns:
      etaSeconds

    • setEtaSeconds

      public void setEtaSeconds(@Nullable Long etaSeconds)

    • equals

      public boolean equals(Object o)
      Return true if this SweepProgress 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