Databricks SDK for JavaScript
    Preparing search index...

    Interface SnapshotSpec

    Client-provided configuration of the snapshot.

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

    Properties

    expiration? pointInTime? sourceBranch?

    Properties

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

    Expiration policy. If unset, the snapshot is kept until deleted.

    Type Declaration

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

        Absolute time at which the snapshot is deleted. Mutually exclusive with ttl and no_expiry.

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

        Time-to-live. The snapshot expires this long after it is created. Mutually exclusive with expire_time and no_expiry. Reads report the resolved absolute expire_time instead.

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

        If true, the snapshot never expires. Mutually exclusive with ttl and expire_time.

    pointInTime?:
        | { $case: "sourceBranchLsn"; sourceBranchLsn: string }
        | { $case: "sourceBranchTime"; sourceBranchTime: Instant }

    The point in time to snapshot from. If unset, the current head of the source branch is used. The chosen LSN or timestamp must fall within the project's point-in-time-recovery window (its history_retention_duration); otherwise the request returns INVALID_PARAMETER_VALUE.

    Type Declaration

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

        LSN to snapshot from, e.g. 16/B374D848. Mutually exclusive with source_branch_time.

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

        Timestamp to snapshot from. Mutually exclusive with source_branch_lsn.

    sourceBranch?: string

    The source branch to snapshot. Format: projects/{project_id}/branches/{branch_id}

    Settings

    Member Visibility

    On This Page

    Properties