Databricks SDK for JavaScript
    Preparing search index...

    Interface BranchSpec

    interface BranchSpec {
        expiration?:
            | { $case: "expireTime"; expireTime: Instant }
            | { $case: "ttl"; ttl: Duration }
            | { $case: "noExpiry"; noExpiry: boolean };
        isProtected?: boolean;
        sourceBranch?: string;
        sourceBranchLsn?: string;
        sourceBranchTime?: Instant;
        sourceSnapshot?: string;
    }
    Index

    Properties

    expiration? isProtected? sourceBranch? sourceBranchLsn? sourceBranchTime? sourceSnapshot?

    Properties

    expiration?:
        | { $case: "expireTime"; expireTime: Instant }
        | { $case: "ttl"; ttl: Duration }
        | { $case: "noExpiry"; noExpiry: boolean }

    Expiration configuration for the branch. One of expire_time, ttl, or no_expiry must be provided. To disable expiration, set no_expiry to true.

    Type Declaration

    • { $case: "expireTime"; expireTime: Instant }
      • $case: "expireTime"
      • expireTime: Instant

        Absolute expiration timestamp. When set, the branch will expire at this time. Mutually exclusive with ttl and no_expiry.

    • { $case: "ttl"; ttl: Duration }
      • $case: "ttl"
      • ttl: Duration

        Relative time-to-live duration. When set, the branch will expire at creation_time + ttl. Mutually exclusive with expire_time and no_expiry.

    • { $case: "noExpiry"; noExpiry: boolean }
      • $case: "noExpiry"
      • noExpiry: boolean

        Explicitly disable expiration. When set to true, the branch will not expire. If set to false, the request is invalid; provide either ttl or expire_time instead. Mutually exclusive with expire_time and ttl.

    isProtected?: boolean

    When set to true, protects the branch from deletion and reset. Associated compute endpoints and the project cannot be deleted while the branch is protected.

    sourceBranch?: string

    The name of the source branch from which this branch was created (data lineage for point-in-time recovery). If not specified, defaults to the project's default branch. Format: projects/{project_id}/branches/{branch_id}

    sourceBranchLsn?: string

    The Log Sequence Number (LSN) on the source branch from which this branch was created.

    sourceBranchTime?: Instant

    The point in time on the source branch from which this branch was created.

    sourceSnapshot?: string

    The snapshot this branch was created from. When set, the branch's data comes from the snapshot rather than a source branch, so source_branch, source_branch_lsn, and source_branch_time must be empty. The snapshot must be AVAILABLE and belong to this branch's project. Format: projects/{project_id}/snapshots/{snapshot_id}

    Settings

    Member Visibility

    On This Page

    Properties