Package com.qtsurfer.api.client.model

Class ExecuteSweepResult

java.lang.Object
com.qtsurfer.api.client.model.ExecuteSweepResult
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class ExecuteSweepResult extends Object
ExecuteSweepResult

  • Field Details

  • Constructor Details

    • ExecuteSweepResult

      public ExecuteSweepResult()

  • Method Details

    • sweepId

      public ExecuteSweepResult sweepId(@Nonnull String sweepId)

    • getSweepId

      @Nonnull public String getSweepId()
      Get sweepId
      Returns:
      sweepId

    • setSweepId

      public void setSweepId(@Nonnull String sweepId)

    • status

      public ExecuteSweepResult status(@Nonnull ExecuteSweepResult.StatusEnum status)

    • getStatus

      @Nonnull public ExecuteSweepResult.StatusEnum getStatus()
      The sweep's own status vocabulary — not the same set `state.status` below uses. See `state` for why.
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull ExecuteSweepResult.StatusEnum status)

    • objective

      public ExecuteSweepResult objective(@Nonnull ExecuteSweepResult.ObjectiveEnum objective)

    • getObjective

      @Nonnull public ExecuteSweepResult.ObjectiveEnum getObjective()
      Get objective
      Returns:
      objective

    • setObjective

      public void setObjective(@Nonnull ExecuteSweepResult.ObjectiveEnum objective)

    • order

      public ExecuteSweepResult order(@Nonnull ExecuteSweepResult.OrderEnum order)

    • getOrder

      @Nonnull public ExecuteSweepResult.OrderEnum getOrder()
      Get order
      Returns:
      order

    • setOrder

      public void setOrder(@Nonnull ExecuteSweepResult.OrderEnum order)

    • ranking

      public ExecuteSweepResult ranking(@Nullable ExecuteSweepResult.RankingEnum ranking)

    • getRanking

      @Nullable public ExecuteSweepResult.RankingEnum getRanking()
      Which ordering was actually applied, which is not always the one requested: a sweep with no stored parameter grid cannot be plateau-ranked and falls back to `raw`. Always `raw` when `order=natural`.
      Returns:
      ranking

    • setRanking

      public void setRanking(@Nullable ExecuteSweepResult.RankingEnum ranking)

    • pbo

      public ExecuteSweepResult pbo(@Nullable Double pbo)

    • getPbo

      @Nullable public Double getPbo()
      Probability of backtest overfitting for the sweep as a whole, by combinatorially symmetric cross-validation: how often the configuration that won in-sample lands below median out-of-sample. Above ~0.5 the sweep is selecting noise, whatever its top row says. Computed once when the last shard finishes, so it is absent while the sweep is still running and on sweeps too small for the statistic to mean anything. minimum: 0 maximum: 1
      Returns:
      pbo

    • setPbo

      public void setPbo(@Nullable Double pbo)

    • pboSplits

      public ExecuteSweepResult pboSplits(@Nullable Integer pboSplits)

    • getPboSplits

      @Nullable public Integer getPboSplits()
      How many train/test splits the `pbo` figure was averaged over.
      Returns:
      pboSplits

    • setPboSplits

      public void setPboSplits(@Nullable Integer pboSplits)

    • failReason

      public ExecuteSweepResult failReason(@Nullable String failReason)

    • getFailReason

      @Nullable public String getFailReason()
      Why the sweep produced less than it should have — the cause reported by the **first** shard to fail, not a list. It is what turns an inscrutable empty leaderboard into an answer: a sweep can come back `PARTIAL` with `done: 0` because the strategy could not be loaded at all, and without this the response says only that nothing finished. First failure wins and later ones are not recorded, so on a sweep where several shards failed for different reasons this names one of them rather than all. Absent when no shard reported a cause, which is the normal case for a healthy sweep — read it together with `progress.failedShards` rather than as a count of anything.
      Returns:
      failReason

    • setFailReason

      public void setFailReason(@Nullable String failReason)

    • progress

      public ExecuteSweepResult progress(@Nonnull SweepProgress progress)

    • getProgress

      @Nonnull public SweepProgress getProgress()
      Get progress
      Returns:
      progress

    • setProgress

      public void setProgress(@Nonnull SweepProgress progress)

    • leaderboardSize

      public ExecuteSweepResult leaderboardSize(@Nonnull Integer leaderboardSize)

    • getLeaderboardSize

      @Nonnull public Integer getLeaderboardSize()
      Total result rows currently available.
      Returns:
      leaderboardSize

    • setLeaderboardSize

      public void setLeaderboardSize(@Nonnull Integer leaderboardSize)

    • truncated

      public ExecuteSweepResult truncated(@Nonnull Boolean truncated)

    • getTruncated

      @Nonnull public Boolean getTruncated()
      True only when the ranked view exceeds its display limit.
      Returns:
      truncated

    • setTruncated

      public void setTruncated(@Nonnull Boolean truncated)

    • leaderboard

      public ExecuteSweepResult leaderboard(@Nonnull List<SweepRunRow> leaderboard)

    • addLeaderboardItem

      public ExecuteSweepResult addLeaderboardItem(SweepRunRow leaderboardItem)

    • getLeaderboard

      @Nonnull public List<SweepRunRow> getLeaderboard()
      Get leaderboard
      Returns:
      leaderboard

    • setLeaderboard

      public void setLeaderboard(@Nonnull List<SweepRunRow> leaderboard)

    • walkForward

      public ExecuteSweepResult walkForward(@Nullable WalkForwardResult walkForward)

    • getWalkForward

      @Nullable public WalkForwardResult getWalkForward()
      Get walkForward
      Returns:
      walkForward

    • setWalkForward

      public void setWalkForward(@Nullable WalkForwardResult walkForward)

    • state

      public ExecuteSweepResult state(@Nonnull JobState state)

    • getState

      @Nonnull public JobState getState()
      The same `JobState` shape a single-execute `BacktestJobResult` carries — not a sweep-specific lookalike, the actual type, so field names and timestamp formatting match exactly. `state.status` uses `JobState`'s own vocabulary (`New`/`Started`/`Completed`/ `Aborted`/`Failed`), mapped from the sweep's `status` field above rather than copying it: `PARTIAL` and `CANCELLED` both map to `Aborted`, because a sweep's `PARTIAL` is already terminal (some shards finished, some failed, nothing more is coming) unlike a single job's non-terminal `Partial`, which has no equivalent here at all. `state.completed` is real ticks processed on a plain sweep. On a `walkForward` sweep it is currently always `0` — the walk-forward fold runner was not wired to count ticks when this shipped, unlike the plain shard path. `state.size` is an upfront estimate — range x the prepare's target cadence, set before any data is even loaded, not a query against loaded data — on a single execute and a plain sweep alike. A plain sweep's value is the sum of every shard's own `size` (each shard's per-run estimate x its own vector slice), the same additive shape `state.completed` already used above. `0` means the prepare context behind the job predates this field (a job whose prepare ran before the estimate existed) — never a guessed cadence standing in for a real one. On a `walkForward` sweep, `state.size` is still always `0`: fold runs were out of scope for the estimate the same way they are for `state.completed` above — a fold's `size` is simply never set, so the sum stays honest at `0` rather than needing a special case.
      Returns:
      state

    • setState

      public void setState(@Nonnull JobState state)

    • equals

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