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

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.BackupforGKE.v1.Data

Assembly: Google.Apis.BackupforGKE.v1.dll

Syntax

public class Backup : IDirectResponseSchema

Properties

AllNamespaces

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

Declaration

[JsonProperty("allNamespaces")]
public virtual bool? AllNamespaces { get; set; }

Property Value

Type	Description
bool?

ClusterMetadata

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

Declaration

[JsonProperty("clusterMetadata")]
public virtual ClusterMetadata ClusterMetadata { get; set; }

Property Value

Type	Description
ClusterMetadata

CompleteTime

object representation of CompleteTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CompleteTimeDateTimeOffset instead.")]
public virtual object CompleteTime { get; set; }

Property Value

Type	Description
object

CompleteTimeDateTimeOffset

DateTimeOffset representation of CompleteTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CompleteTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CompleteTimeRaw

Output only. Completion time of the Backup

Declaration

[JsonProperty("completeTime")]
public virtual string CompleteTimeRaw { get; set; }

Property Value

Type	Description
string

ConfigBackupSizeBytes

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

Declaration

[JsonProperty("configBackupSizeBytes")]
public virtual long? ConfigBackupSizeBytes { get; set; }

Property Value

Type	Description
long?

ContainsSecrets

Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.

Declaration

[JsonProperty("containsSecrets")]
public virtual bool? ContainsSecrets { get; set; }

Property Value

Type	Description
bool?

ContainsVolumeData

Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.

Declaration

[JsonProperty("containsVolumeData")]
public virtual bool? ContainsVolumeData { get; set; }

Property Value

Type	Description
bool?

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

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

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

DeleteLockDays

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 setting and may only be increased (either at creation time or in a subsequent update).

Declaration

[JsonProperty("deleteLockDays")]
public virtual int? DeleteLockDays { get; set; }

Property Value

Type	Description
int?

DeleteLockExpireTime

object representation of DeleteLockExpireTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteLockExpireTimeDateTimeOffset instead.")]
public virtual object DeleteLockExpireTime { get; set; }

Property Value

Type	Description
object

DeleteLockExpireTimeDateTimeOffset

DateTimeOffset representation of DeleteLockExpireTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? DeleteLockExpireTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

DeleteLockExpireTimeRaw

Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).

Declaration

[JsonProperty("deleteLockExpireTime")]
public virtual string DeleteLockExpireTimeRaw { get; set; }

Property Value

Type	Description
string

Description

Optional. User specified descriptive string for this Backup.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

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.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("encryptionKey")]
public virtual EncryptionKey EncryptionKey { get; set; }

Property Value

Type	Description
EncryptionKey

Labels

Optional. A set of custom labels supplied by user.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Manual

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.

Declaration

[JsonProperty("manual")]
public virtual bool? Manual { get; set; }

Property Value

Type	Description
bool?

Name

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

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

PermissiveMode

Output only. If false, Backup will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Inherited from the parent BackupPlan's permissive_mode value.

Declaration

[JsonProperty("permissiveMode")]
public virtual bool? PermissiveMode { get; set; }

Property Value

Type	Description
bool?

PodCount

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

Declaration

[JsonProperty("podCount")]
public virtual int? PodCount { get; set; }

Property Value

Type	Description
int?

ResourceCount

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

Declaration

[JsonProperty("resourceCount")]
public virtual int? ResourceCount { get; set; }

Property Value

Type	Description
int?

RetainDays

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 and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.

Declaration

[JsonProperty("retainDays")]
public virtual int? RetainDays { get; set; }

Property Value

Type	Description
int?

RetainExpireTime

object representation of RetainExpireTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use RetainExpireTimeDateTimeOffset instead.")]
public virtual object RetainExpireTime { get; set; }

Property Value

Type	Description
object

RetainExpireTimeDateTimeOffset

DateTimeOffset representation of RetainExpireTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? RetainExpireTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

RetainExpireTimeRaw

Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).

Declaration

[JsonProperty("retainExpireTime")]
public virtual string RetainExpireTimeRaw { get; set; }

Property Value

Type	Description
string

SatisfiesPzi

Output only. [Output Only] Reserved for future use.

Declaration

[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. [Output Only] Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

SelectedApplications

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

Declaration

[JsonProperty("selectedApplications")]
public virtual NamespacedNames SelectedApplications { get; set; }

Property Value

Type	Description
NamespacedNames

SelectedNamespaces

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

Declaration

[JsonProperty("selectedNamespaces")]
public virtual Namespaces SelectedNamespaces { get; set; }

Property Value

Type	Description
Namespaces

SizeBytes

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

Declaration

[JsonProperty("sizeBytes")]
public virtual long? SizeBytes { get; set; }

Property Value

Type	Description
long?

State

Output only. Current state of the Backup

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

StateReason

Output only. Human-readable description of why the backup is in the current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.

Declaration

[JsonProperty("stateReason")]
public virtual string StateReason { get; set; }

Property Value

Type	Description
string

Uid

Output only. Server generated global unique identifier of UUID4

Declaration

[JsonProperty("uid")]
public virtual string Uid { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

VolumeCount

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

Declaration

[JsonProperty("volumeCount")]
public virtual int? VolumeCount { get; set; }

Property Value

Type	Description
int?

Implements

IDirectResponseSchema