Package Classes (0.5.19)

BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.

BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.

A pager for iterating through list_backup_channels requests.

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

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

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

A pager for iterating through list_backup_channels requests.

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

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

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

A pager for iterating through list_backup_plan_bindings requests.

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

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

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

A pager for iterating through list_backup_plan_bindings requests.

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

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

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

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.

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.

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.

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.

A pager for iterating through list_restore_channels requests.

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

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

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

A pager for iterating through list_restore_channels requests.

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

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

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

A pager for iterating through list_restore_plan_bindings requests.

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

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

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

A pager for iterating through list_restore_plan_bindings requests.

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

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

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

A pager for iterating through list_restore_plans requests.

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

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

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

A pager for iterating through list_restore_plans requests.

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

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

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

A pager for iterating through list_restores requests.

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

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

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

A pager for iterating through list_restores requests.

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

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

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

A pager for iterating through list_volume_backups requests.

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

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

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

A pager for iterating through list_volume_backups requests.

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

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

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

A pager for iterating through list_volume_restores requests.

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

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

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

A pager for iterating through list_volume_restores requests.

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

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

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

Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups).

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

Information about the GKE cluster from which this Backup was created.

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

The abstract base class for a message.

The abstract base class for a message.

A BackupChannel imposes constraints on where clusters can be backed up. The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destination_project.

The abstract base class for a message.

Defines the configuration and scheduling for a "line" of Backups.

BackupConfig defines the configuration of Backups created via this BackupPlan.

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

The abstract base class for a message.

RetentionPolicy defines a Backup retention policy for a BackupPlan.

Defines scheduling parameters for automatically creating Backups via this BackupPlan.

A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.

Contains metadata about the backup plan/backup.

BackupConfigDetails defines the configuration of Backups created via this BackupPlan.

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

RetentionPolicyDetails defines a Backup retention policy for a BackupPlan.

Request message for CreateBackupChannel.

Request message for CreateBackupPlan.

Request message for CreateBackup.

Request message for CreateRestoreChannel.

Request message for CreateRestorePlan.

Request message for CreateRestore.

Request message for DeleteBackupChannel.

Request message for DeleteBackupPlan.

Request message for DeleteBackup.

Request message for DeleteRestoreChannel.

Request message for DeleteRestorePlan.

Request message for DeleteRestore.

Defined a customer managed encryption key that will be used to encrypt Backup artifacts.

Defines a time window during which no backup should happen. All time and date are in UTC.

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

Holds repeated DaysOfWeek values as a container.

Request message for GetBackupChannel.

Request message for GetBackupIndexDownloadUrl.

Response message for GetBackupIndexDownloadUrl.

Request message for GetBackupPlanBinding.

Request message for GetBackupPlan.

Request message for GetBackup.

Request message for GetRestoreChannel.

Request message for GetRestorePlanBinding.

Request message for GetRestorePlan.

Request message for GetRestore.

Request message for GetVolumeBackup.

Request message for GetVolumeRestore.

Request message for ListBackupChannels.

Response message for ListBackupChannels.

Request message for ListBackupPlanBindings.

Response message for ListBackupPlanBindings.

Request message for ListBackupPlans.

Response message for ListBackupPlans.

Request message for ListBackups.

Response message for ListBackups.

Request message for ListRestoreChannels.

Response message for ListRestoreChannels.

Request message for ListRestorePlanBindings.

Response message for ListRestorePlanBindings.

Request message for ListRestorePlans.

Response message for ListRestorePlans.

Request message for ListRestores.

Response message for ListRestores.

Request message for ListVolumeBackups.

Response message for ListVolumeBackups.

Request message for ListVolumeRestores.

Response message for ListVolumeRestores.

A reference to a namespaced resource in Kubernetes.

A list of namespaced Kubernetes resources.

A list of Kubernetes Namespaces.

Represents the metadata of the long-running operation.

Defines a selector to identify a single or a group of resources. Conditions in the selector are optional, but at least one field should be set to a non-empty value. If a condition is not specified, no restrictions will be applied on that dimension. If more than one condition is specified, a resource will be selected if and only if all conditions are met.

The abstract base class for a message.

Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself.

Defines the filter for Restore. This filter can be used to further refine the resource selection of the Restore beyond the coarse-grained scope defined in the RestorePlan. exclusion_filters take precedence over inclusion_filters. If a resource matches both inclusion_filters and exclusion_filters, it will not be restored.

The abstract base class for a message.

Possible values for state of the Restore.

A RestoreChannel imposes constraints on where backups can be restored. The RestoreChannel should be in the same project and region as the backups. The backups can only be restored in the destination_project.

The abstract base class for a message.

Configuration of a restore.

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

Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster.

Defines the scope of cluster-scoped resources to restore.

Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds.

• Node
• ComponentStatus
• gkebackup.gke.io/BackupJob
• gkebackup.gke.io/RestoreJob
• metrics.k8s.io/NodeMetrics
• migration.k8s.io/StorageState
• migration.k8s.io/StorageVersionMigration
• snapshot.storage.k8s.io/VolumeSnapshotContent
• storage.k8s.io/CSINode
• storage.k8s.io/VolumeAttachment

Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here.

• Namespace
• PersistentVolume

This is a direct map to the Kubernetes GroupKind type GroupKind <https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind>__ and is used for identifying specific "types" of resources to restore.

Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster.

 - RESTORE_VOLUME_DATA_FROM_BACKUP: restore data only and respect the reclaim policy of the original PV; - REUSE_VOLUME_HANDLE_FROM_BACKUP: reconnect and respect the reclaim policy of the original PV; - NO_VOLUME_DATA_RESTORATION: new provision and respect the reclaim policy of the original PV. Note that this mode could cause data loss as the original PV can be retained or deleted depending on its reclaim policy. MERGE_REPLACE_ON_CONFLICT (5): This mode merges the backup and the target cluster and replaces the conflicting resources with the ones in the backup. If a single resource to restore exists in the cluster before restoration, the resource will be replaced with the one from the backup. To replace an existing resource, the first attempt is to update the resource to match the one from the backup; if the update fails, the second attempt is to delete the resource and restore it from the backup. Note that this mode could cause data loss as it replaces the existing resources in the target cluster, and the original PV can be retained or deleted depending on its reclaim policy. 

ResourceFilter specifies matching criteria to limit the scope of a change to a specific set of kubernetes resources that are selected for restoration from a backup.

Allows customers to specify dependencies between resources that Backup for GKE can use to compute a resasonable restore order.

Defines a dependency between two group kinds.

A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.

A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to transform) and transformation logic.

TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)

Possible values for operations of a transformation rule action.

 1. If the target location specifies an array index, a new value is inserted into the array at the specified index. 2. If the target location specifies an object member that does not already exist, a new member is added to the object. 3. If the target location specifies an object member that does exist, that member's value is replaced. TEST (5): The "test" operation tests that a value at the target location is equal to a specified value. REPLACE (6): The "replace" operation replaces the value at the target location with a new value. The operation object MUST contain a "value" member whose content specifies the replacement value. 

Defines how volume data should be restored.

Binds resources in the scope to the given VolumeDataRestorePolicy.

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

The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.

The abstract base class for a message.

A RestorePlanBinding binds a RestorePlan with a RestoreChannel. This resource is created automatically when a RestorePlan is created using a RestoreChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.

Defines RPO scheduling configuration for automatically creating Backups via this BackupPlan.

Request message for UpdateBackupChannel.

Request message for UpdateBackupPlan.

Request message for UpdateBackup.

Request message for UpdateRestoreChannel.

Request message for UpdateRestorePlan.

Request message for UpdateRestore.

Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.

The current state of a VolumeBackup

Identifies the format used for the volume backup.

Defines an override to apply a VolumeDataRestorePolicy for scoped resources.

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

Represents the operation of restoring a volume from a VolumeBackup.

The current state of a VolumeRestore

Supported volume types.

Message to encapsulate VolumeType enum.

Supported volume types.

API documentation for gke_backup_v1.services.backup_for_gke.pagers module.