Interface TaskProgress

Details about a task.

interface TaskProgress {
    description?: string;
    elapsedRuntime: number;
    finished?: string;
    id: string;
    lastUpdate: string;
    message?: string;
    progress: number;
    result?: unknown;
    self: string;
    started?: string;
    status:
        | "CANCELLED"
        | "ENQUEUED"
        | "RUNNING"
        | "COMPLETE"
        | "FAILED"
        | "CANCEL_REQUESTED"
        | "DEAD";
    submitted?: string;
    submittedBy: number;
}

Hierarchy

  • Record<string, unknown>
    • TaskProgress

Properties

description? elapsedRuntime finished? id lastUpdate message? progress result? self started? status submitted? submittedBy

Properties

Optionaldescription

description?: string

The description of the task.

elapsedRuntime

elapsedRuntime: number

The execution time of the task, in milliseconds.

Optionalfinished

finished?: string

A timestamp recording when the task was finished.

id

id: string

The ID of the task.

lastUpdate

lastUpdate: string

A timestamp recording when the task progress was last updated.

Optionalmessage

message?: string

Information about the progress of the task.

progress

progress: number

The progress of the task, as a percentage complete.

Optionalresult

result?: unknown

The result of the task execution.

self

self: string

The URL of the task.

Optionalstarted

started?: string

A timestamp recording when the task was started.

status

status:
    | "CANCELLED"
    | "ENQUEUED"
    | "RUNNING"
    | "COMPLETE"
    | "FAILED"
    | "CANCEL_REQUESTED"
    | "DEAD"

The status of the task.

Optionalsubmitted

submitted?: string

A timestamp recording when the task was submitted.

submittedBy

submittedBy: number

The ID of the user who submitted the task.

Settings

Member Visibility

On This Page

Properties