@nebius/js-sdk - v0.1.41
    Preparing search index...

    Interface ProgressTracker

    Information for tracking the progress of a task (e.g., an API operation or background maintenance action). This serves as a UI contract and may be directly reflected in CLI, Console, and other tools.

    interface ProgressTracker {
        "[customJson]"?: () => unknown;
        "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>;
        $type: "nebius.common.v1.ProgressTracker";
        description: string;
        estimatedFinishedAt?: Dayjs;
        finishedAt?: Dayjs;
        startedAt?: Dayjs;
        steps: ProgressTracker_Step[];
        workDone?: ProgressTracker_WorkDone;
        [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined;
    }

    Indexable

    • [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined
    Index

    Properties

    [customJson]? [unknownFieldsSymbol]? $type description estimatedFinishedAt? finishedAt? startedAt? steps workDone?

    Properties

    "[customJson]"?: () => unknown
    "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>
    $type: "nebius.common.v1.ProgressTracker"
    description: string

    Human-readable description of the currently executing task, e.g., "Downloading dat-groot-llm.tar.xz". Relates to the overall task, not individual steps. SHOULD match the Operation's description field when this ProgressTracker tracks an API Operation's progress. MAY provide more detailed overall information.

    MUST be suitable for display to public users. Even if the task is internal, this description may be shown to end users in overall task step descriptions.

    For individual step descriptions, use Step.description.

    estimatedFinishedAt?: Dayjs

    Estimated completion timestamp for the task. MUST be absent if the task is completed (i.e., finished_at is set). MAY be absent if the estimate is unknown. MAY be updated as the progress estimate changes.

    finishedAt?: Dayjs

    Completion timestamp of the task. MUST be absent for running tasks; MUST be present for completed tasks. MUST match the operation's finished_at timestamp when tracking an API Operation's progress.

    startedAt?: Dayjs

    Timestamp when the overall task started. MUST match the operation's created_at timestamp when tracking an API Operation's progress.

    steps: ProgressTracker_Step[]

    Detailed information about the task steps that are currently running or have been finished.

    • For a completed task, the step list MUST either be empty or contain finished steps only.
    • For a running task, the step list MAY be empty if the task consists of a single step or no detailed information is available. A non-empty step list MUST include all currently running steps and MAY include some or all finished steps.
    • Service SHOULD provide both running and finished steps if the task has around 10-20 steps, and provide only running steps otherwise. Service MUST consistently choose either the "running steps only" or the "running + finished steps" behavior.
    • The UI, CLI etc. MAY choose not to display all steps provided by the service.
    workDone?: ProgressTracker_WorkDone

    Overall work progress details. MAY be absent if unknown.

    Settings

    Member Visibility

    On This Page

    Properties