Databricks SDK for JavaScript
    Preparing search index...

    Interface ProjectSpec

    interface ProjectSpec {
        budgetPolicyId?: string;
        customTags?: ProjectCustomTag[];
        defaultBranch?: string;
        defaultEndpointSettings?: ProjectDefaultEndpointSettings;
        displayName?: string;
        enablePgNativeLogin?: boolean;
        historyRetentionDuration?: Duration;
        pgVersion?: number;
    }
    Index

    Properties

    budgetPolicyId? customTags? defaultBranch? defaultEndpointSettings? displayName? enablePgNativeLogin? historyRetentionDuration? pgVersion?

    Properties

    budgetPolicyId?: string

    The desired budget policy to associate with the project. See status.budget_policy_id for the policy that is actually applied to the project.

    customTags?: ProjectCustomTag[]

    Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking. To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask. To clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask. To preserve existing tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags).

    defaultBranch?: string

    The full resource path for the default branch of the project Format: projects/{project_id}/branches/{branch_id}

    defaultEndpointSettings?: ProjectDefaultEndpointSettings
    displayName?: string

    Human-readable project name. Length should be between 1 and 256 characters.

    enablePgNativeLogin?: boolean

    Whether to enable PG native password login on all endpoints in this project. Defaults to false.

    historyRetentionDuration?: Duration

    The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days).

    pgVersion?: number

    The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values.

    Settings

    Member Visibility

    On This Page

    Properties