Backup for GKE v1 API - Class Backup (2.5.0) 

public sealed class Backup : IMessage<Backup>, IEquatable<Backup>, IDeepCloneable<Backup>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup for GKE v1 API class Backup.

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).

Inheritance

object > Backup

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

Backup()

public Backup()

Backup(Backup)

public Backup(Backup other)
Parameter
Name Description
other Backup

Properties

AllNamespaces

public bool AllNamespaces { get; set; }

Output only. If True, all namespaces were included in the Backup.

Property Value
Type Description
bool

BackupName

public BackupName BackupName { get; set; }

BackupName-typed view over the Name resource name property.

Property Value
Type Description
BackupName

BackupScopeCase

public Backup.BackupScopeOneofCase BackupScopeCase { get; }
Property Value
Type Description
BackupBackupScopeOneofCase

ClusterMetadata

public Backup.Types.ClusterMetadata ClusterMetadata { get; set; }

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

Property Value
Type Description
BackupTypesClusterMetadata

CompleteTime

public Timestamp CompleteTime { get; set; }

Output only. Completion time of the Backup

Property Value
Type Description
Timestamp

ConfigBackupSizeBytes

public long ConfigBackupSizeBytes { get; set; }

Output only. The size of the config backup in bytes.

Property Value
Type Description
long

ContainsSecrets

public bool ContainsSecrets { get; set; }

Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's [include_secrets][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_secrets] value.

Property Value
Type Description
bool

ContainsVolumeData

public bool ContainsVolumeData { get; set; }

Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's [include_volume_data][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.include_volume_data] value.

Property Value
Type Description
bool

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The timestamp when this Backup resource was created.

Property Value
Type Description
Timestamp

DeleteLockDays

public int DeleteLockDays { get; set; }

Optional. 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][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_delete_lock_days] setting and may only be increased (either at creation time or in a subsequent update).

Property Value
Type Description
int

DeleteLockExpireTime

public Timestamp DeleteLockExpireTime { get; set; }

Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + [delete_lock_days][google.cloud.gkebackup.v1.Backup.delete_lock_days]).

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

Optional. User specified descriptive string for this Backup.

Property Value
Type Description
string

EncryptionKey

public EncryptionKey EncryptionKey { get; set; }

Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's [encryption_key][google.cloud.gkebackup.v1.BackupPlan.BackupConfig.encryption_key] value.

Property Value
Type Description
EncryptionKey

Etag

public string Etag { get; set; }

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.

Property Value
Type Description
string

HasAllNamespaces

public bool HasAllNamespaces { get; }

Gets whether the "all_namespaces" field is set

Property Value
Type Description
bool

Labels

public MapField<string, string> Labels { get; }

Optional. A set of custom labels supplied by user.

Property Value
Type Description
MapFieldstringstring

Manual

public bool Manual { get; set; }

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.

Property Value
Type Description
bool

Name

public string Name { get; set; }

Output only. The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*

Property Value
Type Description
string

PodCount

public int PodCount { get; set; }

Output only. The total number of Kubernetes Pods contained in the Backup.

Property Value
Type Description
int

ResourceCount

public int ResourceCount { get; set; }

Output only. The total number of Kubernetes resources included in the Backup.

Property Value
Type Description
int

RetainDays

public int RetainDays { get; set; }

Optional. 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][google.cloud.gkebackup.v1.Backup.delete_lock_days] and <= 365.

Once a Backup is created, this value may only be increased.

Defaults to the parent BackupPlan's [backup_retain_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days] value.

Property Value
Type Description
int

RetainExpireTime

public Timestamp RetainExpireTime { get; set; }

Output only. The time at which this Backup will be automatically deleted (calculated from create_time + [retain_days][google.cloud.gkebackup.v1.Backup.retain_days]).

Property Value
Type Description
Timestamp

SelectedApplications

public NamespacedNames SelectedApplications { get; set; }

Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

Property Value
Type Description
NamespacedNames

SelectedNamespaces

public Namespaces SelectedNamespaces { get; set; }

Output only. If set, the list of namespaces that were included in the Backup.

Property Value
Type Description
Namespaces

SizeBytes

public long SizeBytes { get; set; }

Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)

Property Value
Type Description
long

State

public Backup.Types.State State { get; set; }

Output only. Current state of the Backup

Property Value
Type Description
BackupTypesState

StateReason

public string StateReason { get; set; }

Output only. Human-readable description of why the backup is in the current state.

Property Value
Type Description
string

Uid

public string Uid { get; set; }

Output only. Server generated global unique identifier of UUID4

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The timestamp when this Backup resource was last updated.

Property Value
Type Description
Timestamp

VolumeCount

public int VolumeCount { get; set; }

Output only. The total number of volume backups contained in the Backup.

Property Value
Type Description
int