Disaster Recovery

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.disasterrecovery module.

class databricks.sdk.service.disasterrecovery.FailoverFailoverGroupRequestFailoverType

The type of failover to perform.

FORCED = "FORCED"

class databricks.sdk.service.disasterrecovery.FailoverGroup(regions: List[str], workspace_sets: List[WorkspaceSet], initial_primary_region: str, create_time: Timestamp | None = None, effective_primary_region: str | None = None, etag: str | None = None, name: str | None = None, replication_point: Timestamp | None = None, state: FailoverGroupState | None = None, unity_catalog_assets: UcReplicationConfig | None = None, update_time: Timestamp | None = None)

A failover group manages disaster recovery across workspace sets, coordinating Unity Catalog and workspace assets replication.

regions: List[str]

List of all regions participating in this failover group.

workspace_sets: List[WorkspaceSet]

Workspace sets, each containing workspaces that replicate to each other.

initial_primary_region: str

Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses.

create_time: Timestamp | None = None

Time at which this failover group was created.

effective_primary_region: str | None = None

Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover.

etag: str | None = None

Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications.

name: str | None = None

Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}.

replication_point: Timestamp | None = None

The latest point in time to which data has been replicated.

state: FailoverGroupState | None = None

Aggregate state of the failover group.

unity_catalog_assets: UcReplicationConfig | None = None

Unity Catalog replication configuration.

update_time: Timestamp | None = None

Time at which this failover group was last modified.

as_dict() → dict

Serializes the FailoverGroup into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the FailoverGroup into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → FailoverGroup

Deserializes the FailoverGroup from a dictionary.

class databricks.sdk.service.disasterrecovery.FailoverGroupState

The aggregate state of a FailoverGroup.

ACTIVE = "ACTIVE"

CREATING = "CREATING"

CREATION_FAILED = "CREATION_FAILED"

DELETING = "DELETING"

DELETION_FAILED = "DELETION_FAILED"

FAILING_OVER = "FAILING_OVER"

FAILOVER_FAILED = "FAILOVER_FAILED"

INITIAL_REPLICATION = "INITIAL_REPLICATION"

class databricks.sdk.service.disasterrecovery.ListFailoverGroupsResponse(failover_groups: List[FailoverGroup] | None = None, next_page_token: str | None = None)

Response for listing failover groups.

failover_groups: List[FailoverGroup] | None = None

The failover groups for this account.

next_page_token: str | None = None

A token that can be sent as page_token to retrieve the next page. If omitted, there are no subsequent pages.

as_dict() → dict

Serializes the ListFailoverGroupsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListFailoverGroupsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListFailoverGroupsResponse

Deserializes the ListFailoverGroupsResponse from a dictionary.

class databricks.sdk.service.disasterrecovery.ListStableUrlsResponse(next_page_token: str | None = None, stable_urls: List[StableUrl] | None = None)

Response for listing stable URLs.

next_page_token: str | None = None

A token that can be sent as page_token to retrieve the next page. If omitted, there are no subsequent pages.

stable_urls: List[StableUrl] | None = None

The stable URLs for this account.

as_dict() → dict

Serializes the ListStableUrlsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListStableUrlsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListStableUrlsResponse

Deserializes the ListStableUrlsResponse from a dictionary.

class databricks.sdk.service.disasterrecovery.LocationMapping(name: str, uri_by_region: List[LocationMappingEntry])

A location mapping identified by a name, with URIs per region. The system derives replication direction from effective_primary_region.

name: str

Resource name for this location.

uri_by_region: List[LocationMappingEntry]

URI for each region. Each entry maps a region name to a storage URI.

as_dict() → dict

Serializes the LocationMapping into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the LocationMapping into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → LocationMapping

Deserializes the LocationMapping from a dictionary.

class databricks.sdk.service.disasterrecovery.LocationMappingEntry(region: str, uri: str)

A single entry in a location mapping, mapping a region to a storage URI. Used instead of map<string, string> for proto2 compatibility.

region: str

The region name.

uri: str

The storage URI for this region.

as_dict() → dict

Serializes the LocationMappingEntry into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the LocationMappingEntry into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → LocationMappingEntry

Deserializes the LocationMappingEntry from a dictionary.

class databricks.sdk.service.disasterrecovery.StableUrl(initial_workspace_id: str, failover_group_name: str | None = None, name: str | None = None, url: str | None = None)

A stable URL provides a failover-aware endpoint for accessing a workspace. Its lifecycle is independent of any failover group.

initial_workspace_id: str

The workspace this stable URL is initially bound to. Used only in Create requests to associate the stable URL with a workspace. Not returned in responses.

failover_group_name: str | None = None

Fully qualified resource name of the FailoverGroup this stable URL is currently linked to, in the format accounts/{account_id}/failover-groups/{failover_group_id}. Empty when the stable URL is not attached to any failover group.

name: str | None = None

Fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.

url: str | None = None

The stable URL endpoint. Generated on creation and immutable thereafter. For non-Private-Link workspaces this is https://<spog_host>/?c=<connection_id>. For Private-Link workspaces this is the per-connection hostname.

as_dict() → dict

Serializes the StableUrl into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the StableUrl into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → StableUrl

Deserializes the StableUrl from a dictionary.

class databricks.sdk.service.disasterrecovery.UcCatalog(name: str)

A Unity Catalog catalog to replicate.

name: str

The name of the UC catalog to replicate.

as_dict() → dict

Serializes the UcCatalog into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the UcCatalog into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UcCatalog

Deserializes the UcCatalog from a dictionary.

class databricks.sdk.service.disasterrecovery.UcReplicationConfig(catalogs: List[UcCatalog], data_replication_workspace_set: str, location_mappings: List[LocationMapping] | None = None)

Unity Catalog replication configuration (top-level, not per-set).

catalogs: List[UcCatalog]

UC catalogs to replicate.

data_replication_workspace_set: str

The workspace set whose workspaces will be used for data replication of all UC catalogs’ underlying storage.

location_mappings: List[LocationMapping] | None = None

Location mappings - storage URI per region for each location.

as_dict() → dict

Serializes the UcReplicationConfig into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the UcReplicationConfig into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UcReplicationConfig

Deserializes the UcReplicationConfig from a dictionary.

class databricks.sdk.service.disasterrecovery.WorkspaceSet(name: str, workspace_ids: List[str], replicate_workspace_assets: bool, stable_url_names: List[str] | None = None)

A set of workspaces that replicate to each other across regions.

name: str

Resource name for this workspace set.

workspace_ids: List[str]

Workspace IDs in this set. The system derives and validates regions. All workspaces must be in the Mission Critical tier.

replicate_workspace_assets: bool

Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set.

stable_url_names: List[str] | None = None

Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl).

as_dict() → dict

Serializes the WorkspaceSet into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the WorkspaceSet into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → WorkspaceSet

Deserializes the WorkspaceSet from a dictionary.