backupdr/v1 library

Backup and DR Service API - v1

For more information, see cloud.google.com/backup-disaster-recovery

Create an instance of BackupdrApi to access these resources:

Classes

AbandonBackupRequest: request message for AbandonBackup.
AcceleratorConfig: A specification of the type and number of accelerator cards attached to the instance.
AccessConfig: An access configuration attached to an instance's network interface.
AdvancedMachineFeatures: Specifies options for controlling advanced machine features.
AliasIpRange: An alias IP range attached to an instance's network interface.
AllocationAffinity: Specifies the reservations that this instance can consume from.
AlloyDBClusterBackupPlanAssociationProperties: Properties for an AlloyDB cluster backup plan association.
AlloyDbClusterBackupProperties: AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties.
AlloyDBClusterDataSourceProperties: AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource.
AlloyDBClusterDataSourceReferenceProperties: AlloyDBClusterDataSourceReferenceProperties represents the properties of an AlloyDB cluster that are stored in the DataSourceReference.
AlloyDbPitrWindow: Point in time recovery window for an AlloyDB cluster.
AppliedAutoProtectionPolicy: AppliedAutoProtectionPolicy is a read-only view of AutoProtectionPolicy and AutoProtectionPolicyBinding resources that apply to a given workload project.
AttachedDisk: An instance-attached disk resource.
AuditConfig: Specifies the audit configuration for a service.
AutoProtectionDetails: AutoProtectionDetails contains the protection details of a resource from the current binding's perspective.
AutoProtectionPolicy: An AutoprotectionPolicy is a policy resource designed to automate backup management, moving from manual per-resource protection to a bulk approach.
AutoProtectionPolicyBinding: An AutoProtectionPolicyBinding (APPA) acts as the bridge between an AutoProtectionPolicy and the scope (Project) where the policy should be applied.
Backup: Message describing a Backup object.
BackupApplianceBackupConfig: BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances.
BackupApplianceBackupProperties: BackupApplianceBackupProperties represents BackupDR backup appliance's properties.
BackupApplianceLockInfo: BackupApplianceLockInfo contains metadata about the backupappliance that created the lock.
BackupConfigDetails: BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.
BackupConfigInfo: BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault.
BackupdrApi
BackupDrPlanConfig: BackupDrPlanConfig has additional information about Google Cloud Backup and DR's Plan backup configuration.
BackupDrPlanRule: BackupDrPlanRule has rule specific information of the backup plan resource.
BackupDrTemplateConfig: Provides additional information about Google Cloud Backup and DR's Template backup configuration.
BackupGcpResource: Minimum details to identify a Google Cloud resource for a backup.
BackupLocation: BackupLocation represents a cloud location where a backup can be stored.
BackupLock: BackupLock represents a single lock on a Backup resource.
BackupPlan: A BackupPlan specifies some common fields, such as description as well as one or more BackupRule messages.
BackupPlanAssociation: A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
BackupPlanDetail: BackupPlanDetail defines configuration of protection.
BackupPlanRevision: BackupPlanRevision represents a snapshot of a BackupPlan at a point in time.
BackupRule: BackupRule binds the backup schedule to a retention policy.
BackupSelectionConfig: Configuration for selecting a backup.
BackupVault: Message describing a BackupVault object.
BackupWindow: BackupWindow defines a window of the day during which backup jobs will run.
Binding: Associates members, or principals, with a role.
BindingMatchingResource: BindingMatchingResource contains the details of a resource that matches the criteria of a binding.
BindingSummary: BindingSummary contains count of different containers covered through this policy.
CleanupPhaseInfo: Info for Cleanup phase execution.
CloudSqlInstanceBackupProperties: CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties.
CloudSqlInstanceInitializationConfig: CloudSqlInstanceInitializationConfig contains the configuration for initializing a Cloud SQL instance.
ComputeInstanceBackupPlanProperties: Properties for a compute instance backup plan.
ComputeInstanceBackupProperties: ComputeInstanceBackupProperties represents Compute Engine instance backup properties.
ComputeInstanceDataSourceProperties: ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource.
ComputeInstanceRestoreProperties: ComputeInstanceRestoreProperties represents Compute Engine instance properties to be overridden during restore.
ComputeInstanceTargetEnvironment: ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore.
ConfidentialInstanceConfig: A set of Confidential Instance options.
Criteria: Criteria specifies a set of criteria for matching resources.
CustomerEncryptionKey: A customer-supplied encryption key.
DataSource: Message describing a DataSource object.
DataSourceBackupApplianceApplication: BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance.
DataSourceBackupConfigInfo: Information of backup configuration on the DataSource.
DataSourceGcpResource: DataSourceGcpResource is used for protected resources that are Google Cloud Resources.
DataSourceGcpResourceInfo: The Google Cloud resource that the DataSource is associated with.
DataSourceReference: DataSourceReference is a reference to a DataSource resource.
DiskBackupPlanProperties: Properties for a disk backup plan.
DiskBackupProperties: DiskBackupProperties represents the properties of a Disk backup.
DiskDataSourceProperties: DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource.
DiskExclusionLabels: Message for selective disk backup exclusion labels.
DiskRestoreProperties: DiskRestoreProperties represents the properties of a Disk restore.
DiskTargetEnvironment: DiskTargetEnvironment represents the target environment for the disk.
DisplayDevice: A set of Display Device options
EncryptionConfig: Message describing the EncryptionConfig of backup vault.
EndTrialRequest: Request message for ending a trial.
Entry: A key/value pair to be used for storing metadata.
ExecutionSummary: Summary of the last execution.
FetchAccessTokenRequest: Request message for FetchAccessToken.
FetchAccessTokenResponse: Response message for FetchAccessToken.
FetchBackupPlanAssociationsForResourceTypeResponse: Response for the FetchBackupPlanAssociationsForResourceType method.
FetchBackupsForResourceTypeResponse: Response for the FetchBackupsForResourceType method.
FetchDataSourceReferencesForResourceTypeResponse: Response for the FetchDataSourceReferencesForResourceType method.
FetchMsComplianceMetadataRequest: Request message for GetMsComplianceMetadata
FetchMsComplianceMetadataResponse: Response message for GetMsComplianceMetadata
FetchResourceBackupConfigsResponse: Response for FetchResourceBackupConfigs.
FetchUsableBackupVaultsResponse: Response message for fetching usable BackupVaults.
FilestoreInstanceBackupProperties: FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource.
FilestoreInstanceDataSourceProperties: FilestoreInstanceDataSourceProperties represents the properties of a Filestore resource that are stored in the DataSource.
FilestoreInstanceDataSourceReferenceProperties: FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference.
FinalizeBackupRequest: Message for finalizing a Backup.
FoldersLocationsResource
FoldersLocationsResourceBackupConfigsResource
FoldersResource
GcpBackupConfig: GcpBackupConfig captures the Backup configuration details for Google Cloud resources.
GCPBackupPlanInfo: GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.
GuestOsFeature: Feature type of the Guest OS.
InitializeParams: Specifies the parameters to initialize this disk.
InitializeServiceRequest: Request message for initializing the service.
InitiateBackupRequest: request message for InitiateBackup.
InitiateBackupResponse: Response message for InitiateBackup.
InitiateDeleteAutoProtectionPolicyBindingRequest: Request message for initiating delete of an AutoProtectionPolicyBinding.
InstanceParams: Additional instance params.
KeyValuePair: KeyValuePair defines a key-value pair for matching resource labels.
LabelKeyValPair: Message for a label key-value pair.
ListAppliedAutoProtectionPoliciesResponse: Response message for ListAppliedAutoProtectionPolicies.
ListAutoProtectionPoliciesResponse: Response message for ListAutoProtectionPolicies.
ListAutoProtectionPolicyBindingsResponse: Response message for ListAutoProtectionPolicyBindings.
ListBackupPlanAssociationsResponse: Response message for List BackupPlanAssociation
ListBackupPlanRevisionsResponse: The response message for getting a list of BackupPlanRevision.
ListBackupPlansResponse: The response message for getting a list of BackupPlan.
ListBackupsResponse: Response message for listing Backups.
ListBackupVaultsResponse: Response message for listing BackupVaults.
ListBindingMatchingResourcesResponse: The response message for getting a list of BindingMatchingResources.
ListDataSourceReferencesResponse: Response for the ListDataSourceReferences method.
ListDataSourcesResponse: Response message for listing DataSources.
ListLocationsResponse: The response message for Locations.ListLocations.
ListManagementServersResponse: Response message for listing management servers.
ListOperationsResponse: The response message for Operations.ListOperations.
ListResourceBackupConfigsResponse: Response for ListResourceBackupConfigs.
ListRestoreTemplateExecutionsResponse: Response message for listing RestoreTemplateExecutions.
ListRestoreTemplatesResponse: Response message for listing RestoreTemplates.
ListRestoreVerificationPlanAssociationsResponse: Response message for ListRestoreVerificationPlanAssociations.
ListRestoreVerificationPlansResponse: The response message for getting a list of RestoreVerificationPlans.
ManagementServer: ManagementServer describes a single BackupDR ManagementServer instance.
ManagementURI: ManagementURI for the Management Server resource.
MatchingCondition: MatchingCondition specifies a set of conditions for matching resources.
Metadata: A metadata key/value entry.
NetAppVolumeBackupPlanAssociationProperties: NetAppVolumeBackupPlanAssociationProperties represents NetApp Volume backup plan association properties in BackupPlanAssociation.
NetAppVolumeBackupProperties: NetAppVolumeBackupProperties represents NetApp Volume backup properties in Backup.
NetAppVolumeDataSourceProperties: NetAppVolumeDataSourceProperties represents NetApp Volume properties stored in DataSource.
NetAppVolumeDataSourceReferenceProperties: NetAppVolumeDataSourceReferenceProperties represents NetApp Volume properties stored in DataSourceReference.
NetworkConfig: Network configuration for ManagementServer instance.
NetworkInterface: A network interface resource attached to an instance.
NetworkPerformanceConfig: Network performance configuration.
NodeAffinity: Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
Operation: This resource represents a long-running operation that is the result of a network API call.
OrganizationsLocationsResource
OrganizationsLocationsResourceBackupConfigsResource
OrganizationsResource
PitrSettings: Point in time recovery settings of the backup configuration resource.
Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
PostRestorePhaseInfo: Info for Post-Restore phase execution.
PreparePhaseInfo: Info for Prepare phase execution.
PreRestorePhaseInfo: Info for Pre-Restore phase execution.
ProjectsLocationsAppliedAutoProtectionPoliciesResource
ProjectsLocationsAutoProtectionPoliciesBindingsMatchingResourcesResource
ProjectsLocationsAutoProtectionPoliciesBindingsResource
ProjectsLocationsAutoProtectionPoliciesResource
ProjectsLocationsBackupPlanAssociationsResource
ProjectsLocationsBackupPlansResource
ProjectsLocationsBackupPlansRevisionsResource
ProjectsLocationsBackupVaultsDataSourcesBackupsResource
ProjectsLocationsBackupVaultsDataSourcesResource
ProjectsLocationsBackupVaultsResource
ProjectsLocationsDataSourceReferencesResource
ProjectsLocationsManagementServersResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsLocationsResourceBackupConfigsResource
ProjectsLocationsRestoreTemplatesExecutionsResource
ProjectsLocationsRestoreTemplatesResource
ProjectsLocationsRestoreVerificationPlansAssociationsResource
ProjectsLocationsRestoreVerificationPlansResource
ProjectsLocationsServiceConfigResource
ProjectsLocationsTrialResource
ProjectsResource
RegionDiskTargetEnvironment: RegionDiskTargetEnvironment represents the target environment for the disk.
ResourceBackupConfig: ResourceBackupConfig represents a resource along with its backup configurations.
RestoreBackupRequest: Request message for restoring from a Backup.
RestoreDiskFromInstanceOptions: Options for creating a disk from a source Compute Instance backup.
RestorePhaseInfo: Info for Restore phase execution.
RestoreTemplate: A RestoreTemplate encapsulates DR readiness configurations for validating backups.
RestoreTemplateExecution: A RestoreTemplateExecution represents a single historical or active execution run.
RestoreVerificationCleanupRule: Defines the specific cleanup action.
RestoreVerificationPlan: A RestoreVerificationPlan specifies the scheduling and clean-up template for automated restore verification.
RestoreVerificationPlanAssociation: A RestoreVerificationPlanAssociation binds a specific workload to a RestoreVerificationPlan.
RuleConfigInfo: Message for rules config info.
RunRestoreTemplateRequest: Request message for running a RestoreTemplate.
Scheduling: Sets the scheduling options for an Instance.
SchedulingDuration: A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution.
ServiceAccount: A service account.
ServiceLockInfo: ServiceLockInfo represents the details of a lock taken by the service on a Backup resource.
SetIamPolicyRequest: Request message for SetIamPolicy method.
SetInternalStatusRequest: Request message for SetStatusInternal method.
StandardSchedule: StandardSchedule defines a schedule that run within the confines of a defined window of days.
Tags: A set of instance tags.
Trial: Represents a Trial for a project.
TriggerBackupRequest: Request message for triggering a backup.
TriggerRestoreVerificationRequest: Request message for TriggerRestoreVerification.
TriggerSummary: TriggerSummary contains the results of the most recent automated restore initiation and the next scheduled execution time.
VerificationPhaseInfo: Info for Verification phase execution.
VerificationSummary: VerificationSummary contains the status and timestamp of the latest Automated Verification test.
WeekDayOfMonth: WeekDayOfMonth defines the week day of the month on which the backups will run.
WorkforceIdentityBasedManagementURI: ManagementURI depending on the Workforce Identity i.e. either 1p or 3p.
WorkforceIdentityBasedOAuth2ClientID: OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p,

Typedefs

AuditLogConfig = $AuditLogConfig: Provides the configuration for logging a type of permissions.
BindingEvaluationSummary = $EvaluationSummary: BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding.
CancelOperationRequest = $Empty: The request message for Operations.CancelOperation.
CloudSqlInstanceBackupPlanAssociationProperties = $InstanceBackupPlanAssociationProperties: Cloud SQL instance's BPA properties.
CloudSqlInstanceDataSourceProperties = $Properties: CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource.
CloudSqlInstanceDataSourceReferenceProperties = $Properties: CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference.
Empty = $Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
Expr = $Expr: Represents a textual expression in the Common Expression Language (CEL) syntax.
FilestoreInstanceBackupPlanAssociationProperties = $InstanceBackupPlanAssociationProperties: Filestore instance's BPA properties.
Location = $Location00: A resource that represents a Google Cloud location.
PolicyEvaluationSummary = $EvaluationSummary: PolicyEvaluationSummary contains the summary of the last run of job that applies policy to matching resources.
PostRestoreConfig = $Config00: Configuration for Post-Restore.
PreRestoreConfig = $Config00: Configuration for Pre-Restore.
RemoveDataSourceRequest = $Request00: Message for deleting a DataSource.
Status = $Status00: The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
SubscribeTrialRequest = $Empty: Request message for subscribing to a trial.
TestIamPermissionsRequest = $TestIamPermissionsRequest00: Request message for TestIamPermissions method.
TestIamPermissionsResponse = $PermissionsResponse: Response message for TestIamPermissions method.
TriggerRestoreCleanupRequest = $Request02: Request message for triggering a restore cleanup.
VerificationConfig = $Config00: Configuration for Verification.

Exceptions / Errors

ApiRequestError: Represents a general error reported by the API endpoint.
DetailedApiRequestError: Represents a specific error reported by the API endpoint.

backupdr/v1 library

Classes

Typedefs

Exceptions / Errors

googleapis package

v1 library