Backup class

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

Inheritance

• Object
• GeneratedMessage
• Backup

Constructors

Backup({String? name, String? uid, Timestamp? createTime, Timestamp? updateTime, bool? manual, Map<String, String>? labels, int? deleteLockDays, Timestamp? deleteLockExpireTime, int? retainDays, Timestamp? retainExpireTime, EncryptionKey? encryptionKey, bool? allNamespaces, Namespaces? selectedNamespaces, NamespacedNames? selectedApplications, bool? containsVolumeData, bool? containsSecrets, Backup_ClusterMetadata? clusterMetadata, Backup_State? state, String? stateReason, Timestamp? completeTime, int? resourceCount, int? volumeCount, Int64? sizeBytes, String? etag, String? description, int? podCount, Int64? configBackupSizeBytes})

factory

Backup.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Backup.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

allNamespaces ↔ bool

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

getter/setter pair

clusterMetadata ↔ Backup_ClusterMetadata

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

getter/setter pair

completeTime ↔ Timestamp

Output only. Completion time of the Backup

getter/setter pair

configBackupSizeBytes ↔ Int64

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

getter/setter pair

containsSecrets ↔ bool

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

getter/setter pair

containsVolumeData ↔ bool

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

getter/setter pair

createTime ↔ Timestamp

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

getter/setter pair

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

getter/setter pair

deleteLockExpireTime ↔ Timestamp

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

getter/setter pair

description ↔ String

User specified descriptive string for this Backup.

getter/setter pair

encryptionKey ↔ EncryptionKey

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

getter/setter pair

etag ↔ String

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.

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

labels → Map<String, String>

A set of custom labels supplied by user.

no setter

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.

getter/setter pair

name ↔ String

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

getter/setter pair

podCount ↔ int

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

getter/setter pair

resourceCount ↔ int

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

getter/setter pair

retainDays ↔ int

The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0:

getter/setter pair

retainExpireTime ↔ Timestamp

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

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectedApplications ↔ NamespacedNames

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

getter/setter pair

selectedNamespaces ↔ Namespaces

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

getter/setter pair

sizeBytes ↔ Int64

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

getter/setter pair

state ↔ Backup_State

Output only. Current state of the Backup

getter/setter pair

stateReason ↔ String

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

getter/setter pair

uid ↔ String

Output only. Server generated global unique identifier of UUID4

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

updateTime ↔ Timestamp

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

getter/setter pair

volumeCount ↔ int

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

getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

inherited

check() → void

inherited

clear() → void

Clears all data that was set in this message.

inherited

clearAllNamespaces() → void

clearBackupScope() → void

clearClusterMetadata() → void

clearCompleteTime() → void

clearConfigBackupSizeBytes() → void

clearContainsSecrets() → void

clearContainsVolumeData() → void

clearCreateTime() → void

clearDeleteLockDays() → void

clearDeleteLockExpireTime() → void

clearDescription() → void

clearEncryptionKey() → void

clearEtag() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearManual() → void

clearName() → void

clearPodCount() → void

clearResourceCount() → void

clearRetainDays() → void

clearRetainExpireTime() → void

clearSelectedApplications() → void

clearSelectedNamespaces() → void

clearSizeBytes() → void

clearState() → void

clearStateReason() → void

clearUid() → void

clearUpdateTime() → void

clearVolumeCount() → void

clone() → Backup

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(Backup)) → Backup

Apply updates to a copy of this message.

override

createEmptyInstance() → Backup

Creates an empty instance of the same message type as this.

override

createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>

Creates a Map representing a map field.

inherited

createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>

Creates List implementing a mutable repeated field.

inherited

ensureClusterMetadata() → Backup_ClusterMetadata

ensureCompleteTime() → Timestamp

ensureCreateTime() → Timestamp

ensureDeleteLockExpireTime() → Timestamp

ensureEncryptionKey() → EncryptionKey

ensureRetainExpireTime() → Timestamp

ensureSelectedApplications() → NamespacedNames

ensureSelectedNamespaces() → Namespaces

ensureUpdateTime() → Timestamp

extensionsAreInitialized() → bool

inherited

freeze() → GeneratedMessage

Make this message read-only.

inherited

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

inherited

getExtension(Extension extension) → dynamic

Returns the value of extension.

inherited

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

inherited

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

inherited

getTagNumber(String fieldName) → int?

inherited

hasAllNamespaces() → bool

hasClusterMetadata() → bool

hasCompleteTime() → bool

hasConfigBackupSizeBytes() → bool

hasContainsSecrets() → bool

hasContainsVolumeData() → bool

hasCreateTime() → bool

hasDeleteLockDays() → bool

hasDeleteLockExpireTime() → bool

hasDescription() → bool

hasEncryptionKey() → bool

hasEtag() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasManual() → bool

hasName() → bool

hasPodCount() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasResourceCount() → bool

hasRetainDays() → bool

hasRetainExpireTime() → bool

hasSelectedApplications() → bool

hasSelectedNamespaces() → bool

hasSizeBytes() → bool

hasState() → bool

hasStateReason() → bool

hasUid() → bool

hasUpdateTime() → bool

hasVolumeCount() → bool

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

inherited

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

inherited

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

inherited

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

inherited

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

inherited

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

inherited

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

inherited

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

inherited

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

inherited

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

inherited

toDebugString() → String

Returns a String representation of this message.

inherited

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

inherited

toString() → String

Returns a String representation of this message.

inherited

whichBackupScope() → Backup_BackupScope

writeToBuffer() → Uint8List

inherited

writeToCodedBufferWriter(CodedBufferWriter output) → void

inherited

writeToJson() → String

Returns a JSON string that encodes this message.

inherited

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create() → Backup

createRepeated() → PbList<Backup>

getDefault() → Backup