Package com.qtsurfer.api.client.model

Class LiveRun

java.lang.Object
com.qtsurfer.api.client.model.LiveRun
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.14.0") public class LiveRun extends Object
A live run's full state, as returned by starting, reading, or stopping it through its strategy.

  • Field Details

  • Constructor Details

    • LiveRun

      public LiveRun()

  • Method Details

    • strategyId

      public LiveRun 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 LiveRun 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 LiveRun name(@Nullable String name)

    • getName

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

    • setName

      public void setName(@Nullable String name)

    • description

      public LiveRun description(@Nullable String description)

    • getDescription

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

    • setDescription

      public void setDescription(@Nullable String description)

    • visibility

      public LiveRun visibility(@Nonnull LiveRun.VisibilityEnum visibility)

    • getVisibility

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

    • setVisibility

      public void setVisibility(@Nonnull LiveRun.VisibilityEnum visibility)

    • stage

      public LiveRun stage(@Nonnull LiveRun.StageEnum stage)

    • getStage

      @Nonnull public LiveRun.StageEnum getStage()
      A new run always starts `SANDBOX` — a trial run compared against a second execution for agreement — and moves to `LIVE` once it passes.
      Returns:
      stage

    • setStage

      public void setStage(@Nonnull LiveRun.StageEnum stage)

    • state

      public LiveRun state(@Nonnull String state)

    • getState

      @Nonnull public String getState()
      `STARTING` until first observed running; otherwise the runner's own reported state (e.g. `RUNNING`).
      Returns:
      state

    • setState

      public void setState(@Nonnull String state)

    • desired

      public LiveRun desired(@Nonnull LiveRun.DesiredEnum desired)

    • getDesired

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

    • setDesired

      public void setDesired(@Nonnull LiveRun.DesiredEnum desired)

    • reason

      public LiveRun reason(@Nullable String reason)

    • getReason

      @Nullable public String getReason()
      Present only when the run stopped because it exceeded its resource allowance.
      Returns:
      reason

    • setReason

      public void setReason(@Nullable String reason)

    • sources

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

    • addSourcesItem

      public LiveRun addSourcesItem(LiveSource sourcesItem)

    • getSources

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

    • setSources

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

    • params

      public LiveRun params(@Nonnull Object params)

    • getParams

      @Nonnull public Object getParams()
      Get params
      Returns:
      params

    • setParams

      public void setParams(@Nonnull Object params)

    • paramsVersion

      public LiveRun paramsVersion(@Nonnull Integer paramsVersion)

    • getParamsVersion

      @Nonnull public Integer getParamsVersion()
      Increments on every accepted `PUT .../params` call, including one that resends the current values.
      Returns:
      paramsVersion

    • setParamsVersion

      public void setParamsVersion(@Nonnull Integer paramsVersion)

    • relay

      public LiveRun relay(@Nonnull Boolean relay)

    • getRelay

      @Nonnull public Boolean getRelay()
      Whether this run's signals are being relayed over the WebSocket channel described in the \"Live execution\" guide, right now. This is the effective value — `false` on a `sandbox` run regardless of what was requested at start; matches the requested value once `stage` reaches `live`.
      Returns:
      relay

    • setRelay

      public void setRelay(@Nonnull Boolean relay)

    • startedAtMs

      public LiveRun startedAtMs(@Nonnull Long startedAtMs)

    • getStartedAtMs

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

    • setStartedAtMs

      public void setStartedAtMs(@Nonnull Long startedAtMs)

    • gate

      public LiveRun gate(@Nullable Object gate)

    • getGate

      @Nullable public Object getGate()
      The sandbox trial's promotion verdict, once one exists. Shape is not yet stabilized as public API — treat as opaque diagnostics.
      Returns:
      gate

    • setGate

      public void setGate(@Nullable Object gate)

    • equals

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