Package Classes (0.1.4)

Summary of entries of Classes for backupdr.

Classes

BackupDRAsyncClient

The BackupDR Service

BackupDRClient

The BackupDR Service

FetchUsableBackupVaultsAsyncPager

A pager for iterating through fetch_usable_backup_vaults requests.

This class thinly wraps an initial FetchUsableBackupVaultsResponse object, and provides an __aiter__ method to iterate through its backup_vaults field.

If there are more pages, the __aiter__ method will make additional FetchUsableBackupVaults requests and continue to iterate through the backup_vaults field on the corresponding responses.

All the usual FetchUsableBackupVaultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

FetchUsableBackupVaultsPager

A pager for iterating through fetch_usable_backup_vaults requests.

This class thinly wraps an initial FetchUsableBackupVaultsResponse object, and provides an __iter__ method to iterate through its backup_vaults field.

If there are more pages, the __iter__ method will make additional FetchUsableBackupVaults requests and continue to iterate through the backup_vaults field on the corresponding responses.

All the usual FetchUsableBackupVaultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupPlanAssociationsAsyncPager

A pager for iterating through list_backup_plan_associations requests.

This class thinly wraps an initial ListBackupPlanAssociationsResponse object, and provides an __aiter__ method to iterate through its backup_plan_associations field.

If there are more pages, the __aiter__ method will make additional ListBackupPlanAssociations requests and continue to iterate through the backup_plan_associations field on the corresponding responses.

All the usual ListBackupPlanAssociationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupPlanAssociationsPager

A pager for iterating through list_backup_plan_associations requests.

This class thinly wraps an initial ListBackupPlanAssociationsResponse object, and provides an __iter__ method to iterate through its backup_plan_associations field.

If there are more pages, the __iter__ method will make additional ListBackupPlanAssociations requests and continue to iterate through the backup_plan_associations field on the corresponding responses.

All the usual ListBackupPlanAssociationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupPlansAsyncPager

A pager for iterating through list_backup_plans requests.

This class thinly wraps an initial ListBackupPlansResponse object, and provides an __aiter__ method to iterate through its backup_plans field.

If there are more pages, the __aiter__ method will make additional ListBackupPlans requests and continue to iterate through the backup_plans field on the corresponding responses.

All the usual ListBackupPlansResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupPlansPager

A pager for iterating through list_backup_plans requests.

This class thinly wraps an initial ListBackupPlansResponse object, and provides an __iter__ method to iterate through its backup_plans field.

If there are more pages, the __iter__ method will make additional ListBackupPlans requests and continue to iterate through the backup_plans field on the corresponding responses.

All the usual ListBackupPlansResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupVaultsAsyncPager

A pager for iterating through list_backup_vaults requests.

This class thinly wraps an initial ListBackupVaultsResponse object, and provides an __aiter__ method to iterate through its backup_vaults field.

If there are more pages, the __aiter__ method will make additional ListBackupVaults requests and continue to iterate through the backup_vaults field on the corresponding responses.

All the usual ListBackupVaultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupVaultsPager

A pager for iterating through list_backup_vaults requests.

This class thinly wraps an initial ListBackupVaultsResponse object, and provides an __iter__ method to iterate through its backup_vaults field.

If there are more pages, the __iter__ method will make additional ListBackupVaults requests and continue to iterate through the backup_vaults field on the corresponding responses.

All the usual ListBackupVaultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupsAsyncPager

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __aiter__ method to iterate through its backups field.

If there are more pages, the __aiter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListBackupsPager

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __iter__ method to iterate through its backups field.

If there are more pages, the __iter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataSourcesAsyncPager

A pager for iterating through list_data_sources requests.

This class thinly wraps an initial ListDataSourcesResponse object, and provides an __aiter__ method to iterate through its data_sources field.

If there are more pages, the __aiter__ method will make additional ListDataSources requests and continue to iterate through the data_sources field on the corresponding responses.

All the usual ListDataSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataSourcesPager

A pager for iterating through list_data_sources requests.

This class thinly wraps an initial ListDataSourcesResponse object, and provides an __iter__ method to iterate through its data_sources field.

If there are more pages, the __iter__ method will make additional ListDataSources requests and continue to iterate through the data_sources field on the corresponding responses.

All the usual ListDataSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListManagementServersAsyncPager

A pager for iterating through list_management_servers requests.

This class thinly wraps an initial ListManagementServersResponse object, and provides an __aiter__ method to iterate through its management_servers field.

If there are more pages, the __aiter__ method will make additional ListManagementServers requests and continue to iterate through the management_servers field on the corresponding responses.

All the usual ListManagementServersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListManagementServersPager

A pager for iterating through list_management_servers requests.

This class thinly wraps an initial ListManagementServersResponse object, and provides an __iter__ method to iterate through its management_servers field.

If there are more pages, the __iter__ method will make additional ListManagementServers requests and continue to iterate through the management_servers field on the corresponding responses.

All the usual ListManagementServersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

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

AccessType

The type of configuration.

NetworkTier

Network tier property used by addresses, instances and forwarding rules.

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

Type

Indicates whether to consume from a reservation or not.

AttachedDisk

An instance-attached disk resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DiskInterface

List of the Disk Interfaces.

DiskMode

List of the Disk Modes.

DiskSavedState

List of the states of the Disk.

DiskType

List of the Disk Types.

InitializeParams

Specifies the parameters to initialize this disk.

.. _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

BackupType

Type of the backup, scheduled or ondemand.

GCPBackupPlanInfo

GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.

LabelsEntry

The abstract base class for a message.

State

Holds the state of the backup resource.

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

LastBackupState

LastBackupstate tracks whether the last backup was not yet started, successful, failed, or could not be run because of the lack of permissions.

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.

LabelsEntry

The abstract base class for a message.

State

State enumerates the possible states for a BackupPlan.

BackupPlanAssociation

A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc

State

Enum for State of BackupPlan Association

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

AccessRestriction

Holds the access restriction for the backup vault.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

State

Holds the state of the backup vault resource.

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

LabelsEntry

The abstract base class for a message.

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

InstancePrivateIpv6GoogleAccess

The private IPv6 google access type for the VMs.

LabelsEntry

The abstract base class for a message.

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

LabelsEntry

The abstract base class for a message.

State

Holds the state of the data source resource.

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

FeatureType

List of the Feature Types.

InstanceParams

Additional instance params.

ResourceManagerTagsEntry

The abstract base class for a message.

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.

InstanceState

State of Management server instance.

InstanceType

Type of backup service resource.

LabelsEntry

The abstract base class for a message.

ManagementURI

ManagementURI for the Management Server resource.

Metadata

A metadata key/value entry.

NetworkConfig

Network configuration for ManagementServer instance.

PeeringMode

VPC peering modes supported by Cloud BackupDR.

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

Ipv6AccessType

IPv6 access type for this network interface.

NicType

Nic type for this network interface.

StackType

Stack type for this network interface.

NetworkPerformanceConfig

Network performance configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Tier

Network performance tier.

OperationMetadata

Represents the metadata of the long-running operation.

AdditionalInfoEntry

The abstract base class for a message.

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.

LastBackupState

Enum for LastBackupState

Scheduling

Sets the scheduling options for an Instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstanceTerminationAction

Defines the supported termination actions for an instance.

NodeAffinity

Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Operator

Defines the type of node selections.

OnHostMaintenance

Defines the maintenance behavior for this instance=

ProvisioningModel

Defines the provisioning model 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. 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.

RecurrenceType

RecurrenceTypes enumerates the applicable periodicity for the schedule.

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.

WeekOfMonth

WeekOfMonth enumerates possible weeks in the month, e.g. the first, third, or last week of the month.

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,

Modules

pagers

API documentation for backupdr_v1.services.backup_dr.pagers module.