API documentation for backupdr_v1.types package.
Classes
AcceleratorConfig
A specification of the type and number of accelerator cards attached to the instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AccessConfig
An access configuration attached to an instance's network interface. Only one access config per instance is supported.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AdvancedMachineFeatures
Specifies options for controlling advanced machine features.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AliasIpRange
An alias IP range attached to an instance's network interface.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AllocationAffinity
Specifies the reservations that this instance can consume from.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AttachedDisk
An instance-attached disk resource.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Backup
Message describing a Backup object.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupApplianceBackupConfig
BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances.
BackupApplianceBackupProperties
BackupApplianceBackupProperties represents BackupDR backup appliance's properties.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupApplianceLockInfo
BackupApplianceLockInfo contains metadata about the backupappliance that created the lock.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupConfigInfo
BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupConfigState
Backup configuration state. Is the resource configured for backup?
BackupLock
BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupPlan
A BackupPlan specifies some common fields, such as
description as well as one or more BackupRule messages. Each
BackupRule has a retention policy and defines a schedule by
which the system is to perform backup workloads.
BackupPlanAssociation
A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
BackupRule
BackupRule binds the backup schedule to a retention policy.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupVault
Message describing a BackupVault object.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupVaultView
BackupVaultView contains enum options for Partial and Full view.
BackupView
BackupView contains enum options for Partial and Full view.
BackupWindow
BackupWindow defines a window of the day during which backup
jobs will run.
ComputeInstanceBackupProperties
ComputeInstanceBackupProperties represents Compute Engine instance backup properties.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ComputeInstanceTargetEnvironment
ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore.
ConfidentialInstanceConfig
A set of Confidential Instance options.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CreateBackupPlanAssociationRequest
Request message for creating a backup plan.
CreateBackupPlanRequest
The request message for creating a BackupPlan.
CreateBackupVaultRequest
Message for creating a BackupVault.
CreateManagementServerRequest
Request message for creating a management server instance.
CustomerEncryptionKey
A customer-supplied encryption key.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataSource
Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataSourceBackupApplianceApplication
BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance.
DataSourceGcpResource
DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DeleteBackupPlanAssociationRequest
Request message for deleting a backup plan association.
DeleteBackupPlanRequest
The request message for deleting a BackupPlan.
DeleteBackupRequest
Message for deleting a Backup.
DeleteBackupVaultRequest
Message for deleting a BackupVault.
DeleteManagementServerRequest
Request message for deleting a management server instance.
DisplayDevice
A set of Display Device options
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Entry
A key/value pair to be used for storing metadata.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FetchUsableBackupVaultsRequest
Request message for fetching usable BackupVaults.
FetchUsableBackupVaultsResponse
Response message for fetching usable BackupVaults.
GcpBackupConfig
GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations.
GcpResource
Minimum details to identify a Google Cloud resource
GetBackupPlanAssociationRequest
Request message for getting a BackupPlanAssociation resource.
GetBackupPlanRequest
The request message for getting a BackupPlan.
GetBackupRequest
Request message for getting a Backup.
GetBackupVaultRequest
Request message for getting a BackupVault.
GetDataSourceRequest
Request message for getting a DataSource instance.
GetManagementServerRequest
Request message for getting a management server instance.
GuestOsFeature
Feature type of the Guest OS.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
InstanceParams
Additional instance params.
KeyRevocationActionType
Specifies whether the virtual machine instance will be shut down on key revocation. It is currently used in instance, instance properties and GMI protos
ListBackupPlanAssociationsRequest
Request message for List BackupPlanAssociation
ListBackupPlanAssociationsResponse
Response message for List BackupPlanAssociation
ListBackupPlansRequest
The request message for getting a list BackupPlan.
ListBackupPlansResponse
The response message for getting a list of BackupPlan.
ListBackupVaultsRequest
Request message for listing backupvault stores.
ListBackupVaultsResponse
Response message for listing BackupVaults.
ListBackupsRequest
Request message for listing Backups.
ListBackupsResponse
Response message for listing Backups.
ListDataSourcesRequest
Request message for listing DataSources.
ListDataSourcesResponse
Response message for listing DataSources.
ListManagementServersRequest
Request message for listing management servers.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListManagementServersResponse
Response message for listing management servers.
ManagementServer
ManagementServer describes a single BackupDR ManagementServer instance.
ManagementURI
ManagementURI for the Management Server resource.
Metadata
A metadata key/value entry.
NetworkConfig
Network configuration for ManagementServer instance.
NetworkInterface
A network interface resource attached to an instance. s
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
NetworkPerformanceConfig
Network performance configuration.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
OperationMetadata
Represents the metadata of the long-running operation.
RestoreBackupRequest
Request message for restoring from a Backup.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RestoreBackupResponse
Response message for restoring from a Backup.
RuleConfigInfo
Message for rules config info.
Scheduling
Sets the scheduling options for an Instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SchedulingDuration
A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ServiceAccount
A service account.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ServiceLockInfo
ServiceLockInfo represents the details of a lock taken by the service on a Backup resource.
StandardSchedule
StandardSchedule defines a schedule that run within the confines
of a defined window of days. We can define recurrence type for
schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY.
Tags
A set of instance tags.
TargetResource
Details of the target resource created/modified as part of restore.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TriggerBackupRequest
Request message for triggering a backup.
UpdateBackupRequest
Request message for updating a Backup.
UpdateBackupVaultRequest
Request message for updating a BackupVault.
UpdateDataSourceRequest
Request message for updating a data source instance.
WeekDayOfMonth
WeekDayOfMonth defines the week day of the month on which the
backups will run. The message combines a WeekOfMonth and
DayOfWeek to produce values like FIRST/MONDAY or
LAST/FRIDAY.
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,