@qtsurfer/api-client
    Preparing search index...

    Type Alias JobState

    Information about a single job

    type JobState = {
        completed: number;
        contextId: string;
        endTime?: string | null;
        size: number;
        startTime?: string | null;
        status: "New" | "Started" | "Completed" | "Aborted" | "Failed";
        statusDetail?: string | null;
    }
    Index
    completed contextId endTime? size startTime? status statusDetail?
    completed: number

    The amount of data processed so far

    contextId: string

    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.

    endTime?: string | null

    Timestamp for when the preparation finished

    size: number

    Total size of the data being prepared

    startTime?: string | null

    Timestamp for when the preparation started

    status: "New" | "Started" | "Completed" | "Aborted" | "Failed"

    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.

    statusDetail?: string | null

    Detailed status information, if available

    Settings
    Member Visibility

    On This Page
    Properties