Databricks SDK for JavaScript
    Preparing search index...

    Interface GetPipelineResponse

    interface GetPipelineResponse {
        cause?: string;
        clusterId?: string;
        creatorUserName?: string;
        effectiveBudgetPolicyId?: string;
        effectivePublishingMode?: PublishingMode;
        health?: PipelineHealthStatus;
        lastModified?: bigint;
        latestUpdates?: UpdateStateInfo[];
        name?: string;
        parameters?: Record<string, string>;
        pipelineId?: string;
        runAs?: PipelinesJobRunAs;
        runAsUserName?: string;
        spec?: PipelineSpec;
        state?: PipelineState_PipelineState;
    }
    Index

    Properties

    cause? clusterId? creatorUserName? effectiveBudgetPolicyId? effectivePublishingMode? health? lastModified? latestUpdates? name? parameters? pipelineId? runAs? runAsUserName? spec? state?

    Properties

    cause?: string

    An optional message detailing the cause of the pipeline state.

    clusterId?: string

    The ID of the cluster that the pipeline is running on.

    creatorUserName?: string

    The username of the pipeline creator.

    effectiveBudgetPolicyId?: string

    Serverless budget policy ID of this pipeline.

    effectivePublishingMode?: PublishingMode

    Publishing mode of the pipeline

    health?: PipelineHealthStatus

    The health of a pipeline.

    lastModified?: bigint

    The last time the pipeline settings were modified or created.

    latestUpdates?: UpdateStateInfo[]

    Status of the latest updates for the pipeline. Ordered with the newest update first.

    name?: string

    A human friendly identifier for the pipeline, taken from the spec.

    parameters?: Record<string, string>

    Key/value map of default parameters to use for pipeline execution. Maximum total size: 10k characters (JSON format)

    pipelineId?: string

    The ID of the pipeline.

    runAs?: PipelinesJobRunAs

    The user or service principal that the pipeline runs as, if specified in the request. This field indicates the explicit configuration of run_as for the pipeline. To find the value in all cases, explicit or implicit, use run_as_user_name.

    runAsUserName?: string

    Username of the user that the pipeline will run on behalf of.

    spec?: PipelineSpec

    The pipeline specification. This field is not returned when called by ListPipelines.

    state?: PipelineState_PipelineState

    The pipeline state.

    Settings

    Member Visibility

    On This Page

    Properties