Class Backup (0.2.1)

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

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). Next id: 28

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

Attributes

Name	Description
name	`str` Output only. The fully qualified name of the Backup. ``projects//locations//backupPlans//backups/``
uid	`str` Output only. Server generated global unique identifier of `UUID4
create_time	`google.protobuf.timestamp_pb2.Timestamp` Output only. The timestamp when this Backup resource was created.
update_time	`google.protobuf.timestamp_pb2.Timestamp` Output only. The timestamp when this Backup resource was last updated.
manual	`bool` Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
labels	`Mapping[str, str]` A set of custom labels supplied by user.
delete_lock_days	`int` Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
delete_lock_expire_time	`google.protobuf.timestamp_pb2.Timestamp` Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
retain_days	`int` The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.
retain_expire_time	`google.protobuf.timestamp_pb2.Timestamp` Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
encryption_key	`google.cloud.gke_backup_v1.types.EncryptionKey` Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
all_namespaces	`bool` Output only. If True, all namespaces were included in the Backup. This field is a member of `oneof`_ ``backup_scope``.
selected_namespaces	`google.cloud.gke_backup_v1.types.Namespaces` Output only. If set, the list of namespaces that were included in the Backup. This field is a member of `oneof`_ ``backup_scope``.
selected_applications	`google.cloud.gke_backup_v1.types.NamespacedNames` Output only. If set, the list of ProtectedApplications whose resources were included in the Backup. This field is a member of `oneof`_ ``backup_scope``.
contains_volume_data	`bool` Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
contains_secrets	`bool` Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
cluster_metadata	`google.cloud.gke_backup_v1.types.Backup.ClusterMetadata` Output only. Information about the GKE cluster from which this Backup was created.
state	`google.cloud.gke_backup_v1.types.Backup.State` Output only. Current state of the Backup
state_reason	`str` Output only. Human-readable description of why the backup is in the current ``state``.
complete_time	`google.protobuf.timestamp_pb2.Timestamp` Output only. Completion time of the Backup
resource_count	`int` Output only. The total number of Kubernetes resources included in the Backup.
volume_count	`int` Output only. The total number of volume backups contained in the Backup.
size_bytes	`int` Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
etag	`str` Output only. ``etag`` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the ``etag`` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An ``etag`` is returned in the response to ``GetBackup``, and systems are expected to put that etag in the request to ``UpdateBackup`` or ``DeleteBackup`` to ensure that their change will be applied to the same version of the resource.
description	`str` User specified descriptive string for this Backup.
pod_count	`int` Output only. The total number of Kubernetes Pods contained in the Backup.
config_backup_size_bytes	`int` Output only. The size of the config backup in bytes.

Inheritance

builtins.object > proto.message.Message > Backup

Classes

ClusterMetadata

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

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

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, `.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.

State

State(value)

State