a.disaster_recovery: DisasterRecovery.v1

class databricks.sdk.service.disasterrecovery.DisasterRecoveryAPI

Manage disaster recovery configurations and execute failover operations.

create_failover_group(parent: str, failover_group: FailoverGroup, failover_group_id: str [, validate_only: Optional[bool]]) → FailoverGroup

Create a new failover group.

Parameters:

  • parent – str The parent resource. Format: accounts/{account_id}.

  • failover_group – FailoverGroup The failover group to create.

  • failover_group_id – str Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}.

  • validate_only – bool (optional) When true, validates the request without creating the failover group.

Returns:

FailoverGroup

create_stable_url(parent: str, stable_url: StableUrl, stable_url_id: str [, validate_only: Optional[bool]]) → StableUrl

Create a new stable URL.

Parameters:

  • parent – str The parent resource. Format: accounts/{account_id}.

  • stable_url – StableUrl The stable URL to create.

  • stable_url_id – str Client-provided identifier for the stable URL. Used to construct the resource name as {parent}/stable-urls/{stable_url_id}.

  • validate_only – bool (optional) When true, validates the request without creating the stable URL.

Returns:

StableUrl

delete_failover_group(name: str [, etag: Optional[str]])

Delete a failover group.

Parameters:

  • name – str The fully qualified resource name of the failover group to delete. Format: accounts/{account_id}/failover-groups/{failover_group_id}.

  • etag – str (optional) Opaque version string for optimistic locking. If provided, must match the current etag. If omitted, the delete proceeds without an etag check.

delete_stable_url(name: str)

Delete a stable URL.

Parameters:

name – str The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.

failover_failover_group(name: str, target_primary_region: str, failover_type: FailoverFailoverGroupRequestFailoverType [, etag: Optional[str]]) → FailoverGroup

Initiate a failover to a new primary region.

Parameters:

  • name – str The fully qualified resource name of the failover group to failover. Format: accounts/{account_id}/failover-groups/{failover_group_id}.

  • target_primary_region – str The target primary region. Must be one of the derived regions and different from the current effective_primary_region. Serves as an idempotency check.

  • failover_type – FailoverFailoverGroupRequestFailoverType The type of failover to perform.

  • etag – str (optional) Opaque version string for optimistic locking. If provided, must match the current etag. If omitted, the failover proceeds regardless of current state.

Returns:

FailoverGroup

get_failover_group(name: str) → FailoverGroup

Get a failover group.

Parameters:

name – str The fully qualified resource name of the failover group. Format: accounts/{account_id}/failover-groups/{failover_group_id}.

Returns:

FailoverGroup

get_stable_url(name: str) → StableUrl

Get a stable URL.

Parameters:

name – str The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.

Returns:

StableUrl

list_failover_groups(parent: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[FailoverGroup]

List failover groups.

Parameters:

  • parent – str The parent resource. Format: accounts/{account_id}.

  • page_size – int (optional) Maximum number of failover groups to return per page: - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0 or unset, the page length is set to a server configured value (recommended); - when set to a value less than 0, an invalid parameter error is returned.

  • page_token – str (optional) Page token received from a previous ListFailoverGroups call. Provide this to retrieve the subsequent page.

Returns:

Iterator over FailoverGroup

list_stable_urls(parent: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[StableUrl]

List stable URLs for an account.

Parameters:

  • parent – str The parent resource. Format: accounts/{account_id}.

  • page_size – int (optional) Maximum number of stable URLs to return per page: - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0 or unset, the page length is set to a server configured value (recommended); - when set to a value less than 0, an invalid parameter error is returned.

  • page_token – str (optional) Page token received from a previous ListStableUrls call. Provide this to retrieve the subsequent page.

Returns:

Iterator over StableUrl

update_failover_group(name: str, failover_group: FailoverGroup, update_mask: FieldMask) → FailoverGroup

Update a failover group.

Parameters:

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

  • failover_group – FailoverGroup The failover group with updated fields. The name field identifies the resource and is populated from the URL path.

  • update_mask – FieldMask Comma-separated list of fields to update.

Returns:

FailoverGroup