Package com.qtsurfer.api.client.model

Class LiveRunSummary

java.lang.Object
com.qtsurfer.api.client.model.LiveRunSummary
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class LiveRunSummary extends Object
A run as it appears in `GET /live` — one of your own, narrower than `LiveRun` (no `params`, `paramsVersion`, `relay`, or `gate`), since listing stays cheap regardless of how many runs you have. Check a specific run's full state with `GET /strategy/{strategyId}/live`.

  • Field Details

  • Constructor Details

    • LiveRunSummary

      public LiveRunSummary()

  • Method Details

    • strategyId

      public LiveRunSummary strategyId(@Nonnull String strategyId)

    • getStrategyId

      @Nonnull public String getStrategyId()
      Unique identifier for a compiled strategy, derived from the source itself: the same code always yields the same id, for every caller. How much formatting the id ignores depends on the language — see `POST /strategy` for exactly which rewrites preserve it and which do not.
      Returns:
      strategyId

    • setStrategyId

      public void setStrategyId(@Nonnull String strategyId)

    • runId

      public LiveRunSummary runId(@Nonnull String runId)

    • getRunId

      @Nonnull public String getRunId()
      This run's own id — its canonical identity for `PATCH`/`PUT .../params` and for `GET /live/public`.
      Returns:
      runId

    • setRunId

      public void setRunId(@Nonnull String runId)

    • name

      public LiveRunSummary name(@Nullable String name)

    • getName

      @Nullable public String getName()
      Get name
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • description

      public LiveRunSummary description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Get description
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • visibility

      public LiveRunSummary visibility(@Nonnull LiveRunSummary.VisibilityEnum visibility)

    • getVisibility

      @Nonnull public LiveRunSummary.VisibilityEnum getVisibility()
      Get visibility
      Returns:
      visibility

    • setVisibility

      public void setVisibility(@Nonnull LiveRunSummary.VisibilityEnum visibility)

    • stage

      public LiveRunSummary stage(@Nonnull LiveRunSummary.StageEnum stage)

    • getStage

      @Nonnull public LiveRunSummary.StageEnum getStage()
      A new run starts `SANDBOX`, a 24-hour trial in which it is compared against a second execution and checked for resource use and stability. A run that passes moves to `LIVE` automatically when the 24 hours are up. A run of a strategy that an earlier run of yours already took through the trial starts `LIVE`, unless you started it with `sandbox: true`.
      Returns:
      stage

    • setStage

      public void setStage(@Nonnull LiveRunSummary.StageEnum stage)

    • state

      public LiveRunSummary state(@Nonnull String state)

    • getState

      @Nonnull public String getState()
      The run's health right now: `STARTING` (no runner has reported on it yet), `RUNNING`, `LAGGING` (behind the market data, usually while catching up; clears by itself), `HUNG` (stuck inside one strategy call for longer than allowed; clears when it returns), `DEGRADED` (its independent executions produced different signals), `FAILED` (refused, could not start or failed while running; `reason` says why) or `STOPPED`. `LAGGING`, `HUNG` and `DEGRADED` come and go on a running run. The set may grow: read an unknown value as a running run with something to look at. See the Live execution guide.
      Returns:
      state

    • setState

      public void setState(@Nonnull String state)

    • desired

      public LiveRunSummary desired(@Nonnull LiveRunSummary.DesiredEnum desired)

    • getDesired

      @Nonnull public LiveRunSummary.DesiredEnum getDesired()
      What you last asked for. `state` can lag this briefly after `DELETE`.
      Returns:
      desired

    • setDesired

      public void setDesired(@Nonnull LiveRunSummary.DesiredEnum desired)

    • reason

      public LiveRunSummary reason(@Nullable String reason)

    • getReason

      @Nullable public String getReason()
      Why the run stopped or failed, when there is something to say; absent otherwise. It is never a stack trace or an internal message. Either `resource: ...` (the platform stopped the run for exceeding its resource allowance; the text says which limit) or one of a fixed set of sentences for a `FAILED` run: the strategy cannot consume the source type the run was started with, the run's definition was refused, the pool address of a `dex` run is not a pool of its protocol on its chain, the platform has no room to follow the pool of a `dex` run, the run could not start after several attempts, the strategy failed while processing data, the run lost its data feed, or the generic `The run failed.`. The set may grow: read an unrecognised sentence as a failure and do not parse it. A `FAILED` run usually stays `desired: RUNNING` until you stop it, and counts as active (`409` on a new start, and toward your live-run limit) until then; one that cannot run, and will not by waiting, because its strategy cannot consume its source type or because the pool of a `dex` run is not a pool or has no room to be followed, is stopped by the platform itself (`desired: STOPPED`), so it holds no place.
      Returns:
      reason

    • setReason

      public void setReason(@Nullable String reason)

    • sources

      public LiveRunSummary sources(@Nonnull List<LiveSource> sources)

    • addSourcesItem

      public LiveRunSummary addSourcesItem(LiveSource sourcesItem)

    • getSources

      @Nonnull public List<LiveSource> getSources()
      Get sources
      Returns:
      sources

    • setSources

      public void setSources(@Nonnull List<LiveSource> sources)

    • createdAtMs

      public LiveRunSummary createdAtMs(@Nonnull Long createdAtMs)

    • getCreatedAtMs

      @Nonnull public Long getCreatedAtMs()
      Epoch milliseconds this run was started.
      Returns:
      createdAtMs

    • setCreatedAtMs

      public void setCreatedAtMs(@Nonnull Long createdAtMs)

    • startedAtMs

      public LiveRunSummary startedAtMs(@Nonnull Long startedAtMs)

    • getStartedAtMs

      @Nonnull public Long getStartedAtMs()
      Epoch milliseconds.
      Returns:
      startedAtMs

    • setStartedAtMs

      public void setStartedAtMs(@Nonnull Long startedAtMs)

    • equals

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