Package Classes (0.5.13)

Summary of entries of Classes for gkebackup.

Classes

BackupForGKEAsyncClient

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

BackupForGKEClient

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

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.

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.

ListRestorePlansAsyncPager

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.

ListRestorePlansPager

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.

ListRestoresAsyncPager

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.

ListRestoresPager

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.

ListVolumeBackupsAsyncPager

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.

ListVolumeBackupsPager

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.

ListVolumeRestoresAsyncPager

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.

ListVolumeRestoresPager

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

ClusterMetadata

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

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

BackupCrdVersionsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

State

BackupPlan

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

BackupConfig

BackupConfig defines the configuration of Backups created via this BackupPlan.

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

LabelsEntry

The abstract base class for a message.

RetentionPolicy

RetentionPolicy defines a Backup retention policy for a BackupPlan.

Schedule

Defines scheduling parameters for automatically creating Backups via this BackupPlan.

State

CreateBackupPlanRequest

Request message for CreateBackupPlan.

CreateBackupRequest

Request message for CreateBackup.

CreateRestorePlanRequest

Request message for CreateRestorePlan.

CreateRestoreRequest

Request message for CreateRestore.

DeleteBackupPlanRequest

Request message for DeleteBackupPlan.

DeleteBackupRequest

Request message for DeleteBackup.

DeleteRestorePlanRequest

Request message for DeleteRestorePlan.

DeleteRestoreRequest

Request message for DeleteRestore.

EncryptionKey

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

ExclusionWindow

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

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

DayOfWeekList

Holds repeated DaysOfWeek values as a container.

GetBackupIndexDownloadUrlRequest

Request message for GetBackupIndexDownloadUrl.

GetBackupIndexDownloadUrlResponse

Response message for GetBackupIndexDownloadUrl.

GetBackupPlanRequest

Request message for GetBackupPlan.

GetBackupRequest

Request message for GetBackup.

GetRestorePlanRequest

Request message for GetRestorePlan.

GetRestoreRequest

Request message for GetRestore.

GetVolumeBackupRequest

Request message for GetVolumeBackup.

GetVolumeRestoreRequest

Request message for GetVolumeRestore.

ListBackupPlansRequest

Request message for ListBackupPlans.

ListBackupPlansResponse

Response message for ListBackupPlans.

ListBackupsRequest

Request message for ListBackups.

ListBackupsResponse

Response message for ListBackups.

ListRestorePlansRequest

Request message for ListRestorePlans.

ListRestorePlansResponse

Response message for ListRestorePlans.

ListRestoresRequest

Request message for ListRestores.

ListRestoresResponse

Response message for ListRestores.

ListVolumeBackupsRequest

Request message for ListVolumeBackups.

ListVolumeBackupsResponse

Response message for ListVolumeBackups.

ListVolumeRestoresRequest

Request message for ListVolumeRestores.

ListVolumeRestoresResponse

Response message for ListVolumeRestores.

NamespacedName

A reference to a namespaced resource in Kubernetes.

NamespacedNames

A list of namespaced Kubernetes resources.

Namespaces

A list of Kubernetes Namespaces

OperationMetadata

Represents the metadata of the long-running operation.

ResourceSelector

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.

LabelsEntry

The abstract base class for a message.

Restore

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

Filter

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.

LabelsEntry

The abstract base class for a message.

State

Possible values for state of the Restore.

RestoreConfig

Configuration of a restore.

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

ClusterResourceConflictPolicy

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

ClusterResourceRestoreScope

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.

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

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

Namespace
PersistentVolume

GroupKind

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.

NamespacedResourceRestoreMode

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

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.

RestoreOrder

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

GroupKindDependency

Defines a dependency between two group kinds.

SubstitutionRule

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.

TransformationRule

TransformationRuleAction

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

Op

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.

Modules

pagers

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