Databricks SDK for JavaScript
    Preparing search index...

    Interface GitSource

    An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.

    If git_source is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting source to WORKSPACE on the task.

    Note: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, git_source must be defined on the job.

    interface GitSource {
        gitProvider?: string;
        gitReference?:
            | { $case: "gitBranch"; gitBranch: string }
            | { $case: "gitTag"; gitTag: string }
            | { $case: "gitCommit"; gitCommit: string };
        gitSnapshot?: GitMetadataSnapshot;
        gitUrl?: string;
        jobSource?: JobSource;
        sparseCheckout?: SparseCheckout;
    }
    Index

    Properties

    gitProvider? gitReference? gitSnapshot? gitUrl? jobSource? sparseCheckout?

    Properties

    gitProvider?: string

    Unique identifier of the service used to host the Git repository. The value is case insensitive.

    gitReference?:
        | { $case: "gitBranch"; gitBranch: string }
        | { $case: "gitTag"; gitTag: string }
        | { $case: "gitCommit"; gitCommit: string }

    Type Declaration

    • { $case: "gitBranch"; gitBranch: string }
      • $case: "gitBranch"
      • gitBranch: string

        Name of the branch to be checked out and used by this job. This field cannot be specified in conjunction with git_tag or git_commit.

    • { $case: "gitTag"; gitTag: string }
      • $case: "gitTag"
      • gitTag: string

        Name of the tag to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_commit.

    • { $case: "gitCommit"; gitCommit: string }
      • $case: "gitCommit"
      • gitCommit: string

        Commit to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_tag.

    gitSnapshot?: GitMetadataSnapshot
    gitUrl?: string

    URL of the repository to be cloned by this job.

    jobSource?: JobSource

    The source of the job specification in the remote repository when the job is source controlled.

    sparseCheckout?: SparseCheckout

    Settings

    Member Visibility

    On This Page

    Properties