BackupPlan(mapping=None, *, ignore_unknown_fields=False, **kwargs)Defines the configuration and scheduling for a "line" of Backups.
Attributes | |
|---|---|
| Name | Description |
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
Optional. 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/*
|
retention_policy |
google.cloud.gke_backup_v1.types.BackupPlan.RetentionPolicy
Optional. RetentionPolicy governs lifecycle of Backups created under this plan. |
labels |
MutableMapping[str, str]
Optional. A set of custom labels supplied by user. |
backup_schedule |
google.cloud.gke_backup_v1.types.BackupPlan.Schedule
Optional. 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
Optional. 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 |
backup_config |
google.cloud.gke_backup_v1.types.BackupPlan.BackupConfig
Optional. 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. |
state |
google.cloud.gke_backup_v1.types.BackupPlan.State
Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update |
state_reason |
str
Output only. Human-readable description of why BackupPlan is in the current state
|
rpo_risk_level |
int
Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk. |
rpo_risk_reason |
str
Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any. |
Classes
BackupConfig
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: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
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 |
RetentionPolicy
RetentionPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)RetentionPolicy defines a Backup retention policy for a BackupPlan.
Schedule
Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)Defines scheduling parameters for automatically creating Backups via this BackupPlan.
State
State(value)Values: STATE_UNSPECIFIED (0): Default first value for Enums. CLUSTER_PENDING (1): Waiting for cluster state to be RUNNING. PROVISIONING (2): The BackupPlan is in the process of being created. READY (3): The BackupPlan has successfully been created and is ready for Backups. FAILED (4): BackupPlan creation has failed. DEACTIVATED (5): The BackupPlan has been deactivated. DELETING (6): The BackupPlan is in the process of being deleted.