Class BackupPlan (0.4.4)

BackupPlan(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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


name str
Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
uid str
Output only. Server generated global unique identifier of UUID __ format.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when this BackupPlan resource was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when this BackupPlan resource was last updated.
description str
User specified descriptive string for this BackupPlan.
cluster str
Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
RetentionPolicy governs lifecycle of Backups created under this plan.
labels MutableMapping[str, str]
A set of custom labels supplied by user.
Defines a schedule for automatic Backup creation via this BackupPlan.
etag str
Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.
deactivated bool
This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
Defines the configuration of Backups created via this BackupPlan.
protected_pod_count int
Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.



BackupConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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:


LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.


RetentionPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

RetentionPolicy defines a Backup retention policy for a BackupPlan.


Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Schedule defines scheduling parameters for automatically creating Backups via this BackupPlan.