Package com.qtsurfer.api.client.model

Class LiveSignal

java.lang.Object
com.qtsurfer.api.client.model.LiveSignal
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class LiveSignal extends Object
One signal, in the same shape the real-time signal channel delivers.

  • Field Details

  • Constructor Details

    • LiveSignal

      public LiveSignal()

  • Method Details

    • v

      public LiveSignal v(@Nonnull Integer v)

    • getV

      @Nonnull public Integer getV()
      Envelope schema version.
      Returns:
      v

    • setV

      public void setV(@Nonnull Integer v)

    • signalId

      public LiveSignal signalId(@Nonnull String signalId)

    • getSignalId

      @Nonnull public String getSignalId()
      Stable id for this exact signal — dedupe on it across reconnects or overlapping reads.
      Returns:
      signalId

    • setSignalId

      public void setSignalId(@Nonnull String signalId)

    • runId

      public LiveSignal runId(@Nonnull String runId)

    • getRunId

      @Nonnull public String getRunId()
      Get runId
      Returns:
      runId

    • setRunId

      public void setRunId(@Nonnull String runId)

    • stage

      public LiveSignal stage(@Nonnull LiveSignal.StageEnum stage)

    • getStage

      @Nonnull public LiveSignal.StageEnum getStage()
      The stage the run was in when this signal was produced.
      Returns:
      stage

    • setStage

      public void setStage(@Nonnull LiveSignal.StageEnum stage)

    • paramsVersion

      public LiveSignal paramsVersion(@Nullable Integer paramsVersion)

    • getParamsVersion

      @Nullable public Integer getParamsVersion()
      The parameter set in force when this signal was produced.
      Returns:
      paramsVersion

    • setParamsVersion

      public void setParamsVersion(@Nullable Integer paramsVersion)

    • type

      public LiveSignal type(@Nonnull LiveSignal.TypeEnum type)

    • getType

      @Nonnull public LiveSignal.TypeEnum getType()
      `paper` items appear only for a run whose `paper.output` is `mix`; they are not relayed over the WebSocket channel.
      Returns:
      type

    • setType

      public void setType(@Nonnull LiveSignal.TypeEnum type)

    • kind

      public LiveSignal kind(@Nullable String kind)

    • getKind

      @Nullable public String getKind()
      `BUY`/`SELL` for a `hint`, the command name for a `command`; for `paper`, what the item is: `fill`, `trade`, `equity`, `mark`, `kpi` or `gap`. Absent otherwise.
      Returns:
      kind

    • setKind

      public void setKind(@Nullable String kind)

    • eventTsMs

      public LiveSignal eventTsMs(@Nonnull Long eventTsMs)

    • getEventTsMs

      @Nonnull public Long getEventTsMs()
      Market time the signal was produced.
      Returns:
      eventTsMs

    • setEventTsMs

      public void setEventTsMs(@Nonnull Long eventTsMs)

    • emittedAtMs

      public LiveSignal emittedAtMs(@Nonnull Long emittedAtMs)

    • getEmittedAtMs

      @Nonnull public Long getEmittedAtMs()
      Time it was published — always at or after `eventTsMs`.
      Returns:
      emittedAtMs

    • setEmittedAtMs

      public void setEmittedAtMs(@Nonnull Long emittedAtMs)

    • instrument

      public LiveSignal instrument(@Nullable LiveSignalInstrument instrument)

    • getInstrument

      @Nullable public LiveSignalInstrument getInstrument()
      The instrument the signal is about. `null` only for a `paper` item about a whole account (`equity`, `mark`, `kpi`), whose `data.currency` names the account.
      Returns:
      instrument

    • setInstrument

      public void setInstrument(@Nullable LiveSignalInstrument instrument)

    • order

      public LiveSignal order(@Nullable LiveSignalOrder order)

    • getOrder

      @Nullable public LiveSignalOrder getOrder()
      Get order
      Returns:
      order

    • setOrder

      public void setOrder(@Nullable LiveSignalOrder order)

    • data

      public LiveSignal data(@Nullable Map<String,Object> data)

    • putDataItem

      public LiveSignal putDataItem(String key, Object dataItem)

    • getData

      @Nullable public Map<String,Object> getData()
      The signal's own free-form payload, what the strategy put there with `signal.set(...)`. Whoever may read the run may read it, so on a `public` run it is public. A signal whose `data` is over 8 KiB (8,192 bytes of its JSON) is not pushed on the WebSocket channel, and `GET /live/{runId}/signals` returns it whole.
      Returns:
      data

    • setData

      public void setData(@Nullable Map<String,Object> data)

    • regenerated

      public LiveSignal regenerated(@Nullable Boolean regenerated)

    • getRegenerated

      @Nullable public Boolean getRegenerated()
      `true` only for a signal republished to fill a gap in the record.
      Returns:
      regenerated

    • setRegenerated

      public void setRegenerated(@Nullable Boolean regenerated)

    • digest

      public LiveSignal digest(@Nonnull String digest)

    • getDigest

      @Nonnull public String getDigest()
      Content hash, for checking that two independent deliveries of the same signal agree.
      Returns:
      digest

    • setDigest

      public void setDigest(@Nonnull String digest)

    • equals

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