Databricks SDK for JavaScript
    Preparing search index...

    Interface ResourceStatus

    Read-only runtime status of one job or pipeline backing a resource.

    Shared across resources: a Rule's single job, a Datasource's main / health / historical-ingestion jobs, and a Datasource's ingestion pipeline (the pipeline_id field is set only for the pipeline). For a datasource's historical ingestion, the shard count is simply the number of historical_job_statuses entries — there is no separate count field.

    Two orthogonal axes are modeled separately (v1 conflated them into a single jobStatus enum): lifecycle (is it configured / does it still exist) and run_state (what the most recent or in-flight run did).

    Every field that holds a ResourceStatus is OUTPUT_ONLY at its use site (Datasource ingest/health/historical/pipeline statuses, Rule status), so the inner fields don't repeat the annotation.

    interface ResourceStatus {
        createTime?: Instant;
        jobId?: string;
        lastCompleteTime?: Instant;
        lastErrorMessage?: string;
        lastStartTime?: Instant;
        lastStatusChangeTime?: Instant;
        lifecycleState?: ResourceStatus_Lifecycle;
        pipelineId?: string;
        runState?: ResourceStatus_RunState;
    }
    Index

    Properties

    createTime? jobId? lastCompleteTime? lastErrorMessage? lastStartTime? lastStatusChangeTime? lifecycleState? pipelineId? runState?

    Properties

    createTime?: Instant
    jobId?: string

    Databricks Jobs API job ID. Unset for a pure ingestion pipeline.

    lastCompleteTime?: Instant

    When the most recent run completed. Pairs with run_state = SUCCEEDED.

    lastErrorMessage?: string

    Most recent error message, if any. Pairs with run_state = FAILED.

    lastStartTime?: Instant

    When the most recent run started. Pairs with run_state = RUNNING.

    lastStatusChangeTime?: Instant
    lifecycleState?: ResourceStatus_Lifecycle

    Scheduling lifecycle of the resource's underlying job/pipeline: whether it is unscheduled, scheduled, stopped, or deleted. Distinct from run_state, which reports the outcome of the most recent run.

    pipelineId?: string

    DLT ingestion-pipeline ID. Set only when this status represents the datasource's ingestion pipeline (unset for job statuses).

    runState?: ResourceStatus_RunState

    Settings

    Member Visibility

    On This Page

    Properties