Package com.qtsurfer.api.client.model

Class JobState

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

  • Field Details

  • Constructor Details

    • JobState

      public JobState()

  • Method Details

    • contextId

      public JobState contextId(@Nonnull String contextId)

    • getContextId

      @Nonnull public String getContextId()
      Identifier for the job's execution context. Its current shape is a colon-delimited string encoding the data source type, an internal user id, the exchange, the job id, and the instrument — but that structure is not a committed contract and may change without notice. Treat it as an opaque token: store and pass it back, don't parse it.
      Returns:
      contextId

    • setContextId

      public void setContextId(@Nonnull String contextId)

    • status

      public JobState status(@Nonnull JobState.StatusEnum status)

    • getStatus

      @Nonnull public JobState.StatusEnum getStatus()
      Current status of the job. Treat `Completed | Aborted | Failed` as terminal; `New | Started` mean keep polling. A single-instrument prepare is always terminal (`Completed`) — decide from `PrepareJobState.coverageRatio` (or `dataFrom`/`dataTo` against an `rt` dataset, which has no ratio), not by polling.
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull JobState.StatusEnum status)

    • statusDetail

      public JobState statusDetail(@Nullable String statusDetail)

    • getStatusDetail

      @Nullable public String getStatusDetail()
      Detailed status information, if available
      Returns:
      statusDetail

    • setStatusDetail

      public void setStatusDetail(@Nullable String statusDetail)

    • size

      public JobState size(@Nonnull Integer size)

    • getSize

      @Nonnull public Integer getSize()
      Total size of the data being prepared
      Returns:
      size

    • setSize

      public void setSize(@Nonnull Integer size)

    • completed

      public JobState completed(@Nonnull Integer completed)

    • getCompleted

      @Nonnull public Integer getCompleted()
      The amount of data processed so far
      Returns:
      completed

    • setCompleted

      public void setCompleted(@Nonnull Integer completed)

    • startTime

      public JobState startTime(@Nullable OffsetDateTime startTime)

    • getStartTime

      @Nullable public OffsetDateTime getStartTime()
      Timestamp for when the preparation started
      Returns:
      startTime

    • setStartTime

      public void setStartTime(@Nullable OffsetDateTime startTime)

    • endTime

      public JobState endTime(@Nullable OffsetDateTime endTime)

    • getEndTime

      @Nullable public OffsetDateTime getEndTime()
      Timestamp for when the preparation finished
      Returns:
      endTime

    • setEndTime

      public void setEndTime(@Nullable OffsetDateTime endTime)

    • equals

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