Class BackupDRClient (0.1.6)

The BackupDR Service

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the backup dr client.

Releases underlying transport's resources.

Returns a fully-qualified backup string.

Returns a fully-qualified backup_plan_association string.

Returns a fully-qualified backup_plan string.

Returns a fully-qualified backup_vault string.

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Create a BackupPlan

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_create_backup_plan():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    backup_plan = backupdr_v1.BackupPlan()
    backup_plan.backup_rules.standard_schedule.recurrence_type = "YEARLY"
    backup_plan.backup_rules.standard_schedule.backup_window.start_hour_of_day = 1820
    backup_plan.backup_rules.standard_schedule.backup_window.end_hour_of_day = 1573
    backup_plan.backup_rules.standard_schedule.time_zone = "time_zone_value"
    backup_plan.backup_rules.rule_id = "rule_id_value"
    backup_plan.backup_rules.backup_retention_days = 2237
    backup_plan.resource_type = "resource_type_value"
    backup_plan.backup_vault = "backup_vault_value"

    request = backupdr_v1.CreateBackupPlanRequest(
        parent="parent_value",
        backup_plan_id="backup_plan_id_value",
        backup_plan=backup_plan,
    )

    # Make the request
    operation = client.create_backup_plan(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Create a BackupPlanAssociation

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_create_backup_plan_association():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    backup_plan_association = backupdr_v1.BackupPlanAssociation()
    backup_plan_association.resource = "resource_value"
    backup_plan_association.backup_plan = "backup_plan_value"

    request = backupdr_v1.CreateBackupPlanAssociationRequest(
        parent="parent_value",
        backup_plan_association_id="backup_plan_association_id_value",
        backup_plan_association=backup_plan_association,
    )

    # Make the request
    operation = client.create_backup_plan_association(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Creates a new BackupVault in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_create_backup_vault():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.CreateBackupVaultRequest(
        parent="parent_value",
        backup_vault_id="backup_vault_id_value",
    )

    # Make the request
    operation = client.create_backup_vault(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Creates a new ManagementServer in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_create_management_server():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.CreateManagementServerRequest(
        parent="parent_value",
        management_server_id="management_server_id_value",
    )

    # Make the request
    operation = client.create_management_server(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified data_source string.

Deletes a Backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_delete_backup():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.DeleteBackupRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a single BackupPlan.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_delete_backup_plan():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.DeleteBackupPlanRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_backup_plan(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a single BackupPlanAssociation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_delete_backup_plan_association():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.DeleteBackupPlanAssociationRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_backup_plan_association(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a BackupVault.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_delete_backup_vault():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.DeleteBackupVaultRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_backup_vault(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a single ManagementServer.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_delete_management_server():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.DeleteManagementServerRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_management_server(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_fetch_usable_backup_vaults():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.FetchUsableBackupVaultsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.fetch_usable_backup_vaults(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Gets details of a Backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_get_backup():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.GetBackupRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_backup(request=request)

    # Handle the response
    print(response)

Gets details of a single BackupPlan.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_get_backup_plan():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.GetBackupPlanRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_backup_plan(request=request)

    # Handle the response
    print(response)

Gets details of a single BackupPlanAssociation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_get_backup_plan_association():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.GetBackupPlanAssociationRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_backup_plan_association(request=request)

    # Handle the response
    print(response)

Gets details of a BackupVault.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_get_backup_vault():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.GetBackupVaultRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_backup_vault(request=request)

    # Handle the response
    print(response)

Gets details of a DataSource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_get_data_source():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.GetDataSourceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_data_source(request=request)

    # Handle the response
    print(response)

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Gets information about a location.

Gets details of a single ManagementServer.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_get_management_server():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.GetManagementServerRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_management_server(request=request)

    # Handle the response
    print(response)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Gets the latest state of a long-running operation.

Lists BackupPlanAssociations in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_list_backup_plan_associations():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.ListBackupPlanAssociationsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backup_plan_associations(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists BackupPlans in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_list_backup_plans():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.ListBackupPlansRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backup_plans(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists BackupVaults in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_list_backup_vaults():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.ListBackupVaultsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backup_vaults(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists Backups in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_list_backups():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.ListBackupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backups(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists DataSources in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_list_data_sources():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.ListDataSourcesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_data_sources(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists information about the supported locations for this service.

Lists ManagementServers in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_list_management_servers():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.ListManagementServersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_management_servers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists operations that match the specified filter in the request.

Returns a fully-qualified management_server string.

Parses a backup path into its component segments.

Parses a backup_plan_association path into its component segments.

Parses a backup_plan path into its component segments.

Parses a backup_vault path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a data_source path into its component segments.

Parses a management_server path into its component segments.

Restore from a Backup

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_restore_backup():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    compute_instance_target_environment = backupdr_v1.ComputeInstanceTargetEnvironment()
    compute_instance_target_environment.project = "project_value"
    compute_instance_target_environment.zone = "zone_value"

    request = backupdr_v1.RestoreBackupRequest(
        compute_instance_target_environment=compute_instance_target_environment,
        name="name_value",
    )

    # Make the request
    operation = client.restore_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Triggers a new Backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_trigger_backup():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.TriggerBackupRequest(
        name="name_value",
        rule_id="rule_id_value",
    )

    # Make the request
    operation = client.trigger_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Updates the settings of a Backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_update_backup():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.UpdateBackupRequest(
    )

    # Make the request
    operation = client.update_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Updates the settings of a BackupVault.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_update_backup_vault():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.UpdateBackupVaultRequest(
    )

    # Make the request
    operation = client.update_backup_vault(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Updates the settings of a DataSource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import backupdr_v1

def sample_update_data_source():
    # Create a client
    client = backupdr_v1.BackupDRClient()

    # Initialize request argument(s)
    request = backupdr_v1.UpdateDataSourceRequest(
    )

    # Make the request
    operation = client.update_data_source(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)