GetBackupResult class
Result data returned by getBackup.
Constructors
-
GetBackupResult({required bool allNamespaces, required ClusterMetadataResponse clusterMetadata, required String completeTime, required String configBackupSizeBytes, required bool containsSecrets, required bool containsVolumeData, required String createTime, required int deleteLockDays, required String deleteLockExpireTime, required String description, required EncryptionKeyResponse encryptionKey, required String etag, required Map<
String, String> labels, required bool manual, required String name, required int podCount, required int resourceCount, required int retainDays, required String retainExpireTime, required NamespacedNamesResponse selectedApplications, required NamespacesResponse selectedNamespaces, required String sizeBytes, required String state, required String stateReason, required String uid, required String updateTime, required int volumeCount}) -
Creates a new GetBackupResult.
allNamespacesIf True, all namespaces were included in the Backup.clusterMetadataInformation about the GKE cluster from which this Backup was created.completeTimeCompletion time of the BackupconfigBackupSizeBytesThe size of the config backup in bytes.containsSecretsWhether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.containsVolumeDataWhether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.createTimeThe timestamp when this Backup resource was created.deleteLockDaysOptional. 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).deleteLockExpireTimeThe time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).descriptionOptional. User specified descriptive string for this Backup.encryptionKeyThe customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.etagetagis 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 theetagin the read-modify-write cycle to perform backup updates in order to avoid race conditions: Anetagis returned in the response toGetBackup, and systems are expected to put that etag in the request toUpdateBackuporDeleteBackupto ensure that their change will be applied to the same version of the resource.labelsOptional. A set of custom labels supplied by user.manualThis 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.nameThe fully qualified name of the Backup.projects/*/locations/*/backupPlans/*/backups/*podCountThe total number of Kubernetes Pods contained in the Backup.resourceCountThe total number of Kubernetes resources included in the Backup.retainDaysOptional. 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.retainExpireTimeThe time at which this Backup will be automatically deleted (calculated from create_time + retain_days).selectedApplicationsIf set, the list of ProtectedApplications whose resources were included in the Backup.selectedNamespacesIf set, the list of namespaces that were included in the Backup.sizeBytesThe total size of the Backup in bytes = config backup size + sum(volume backup sizes)stateCurrent state of the BackupstateReasonHuman-readable description of why the backup is in the currentstate.uidServer generated global unique identifier of UUID4updateTimeThe timestamp when this Backup resource was last updated.volumeCountThe total number of volume backups contained in the Backup.const -
GetBackupResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- allNamespaces → bool
-
If True, all namespaces were included in the Backup.
final
- clusterMetadata → ClusterMetadataResponse
-
Information about the GKE cluster from which this Backup was created.
final
- completeTime → String
-
Completion time of the Backup
final
- configBackupSizeBytes → String
-
The size of the config backup in bytes.
final
- containsSecrets → bool
-
Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
final
- containsVolumeData → bool
-
Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
final
- createTime → String
-
The timestamp when this Backup resource was created.
final
- deleteLockDays → int
-
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).
final
- deleteLockExpireTime → String
-
The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
final
- description → String
-
Optional. User specified descriptive string for this Backup.
final
- encryptionKey → EncryptionKeyResponse
-
The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.
final
- etag → String
-
etagis 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 theetagin the read-modify-write cycle to perform backup updates in order to avoid race conditions: Anetagis returned in the response toGetBackup, and systems are expected to put that etag in the request toUpdateBackuporDeleteBackupto ensure that their change will be applied to the same version of the resource.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
labels
→ Map<
String, String> -
Optional. A set of custom labels supplied by user.
final
- manual → bool
-
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.
final
- name → String
-
The fully qualified name of the Backup.
projects/*/locations/*/backupPlans/*/backups/*final - podCount → int
-
The total number of Kubernetes Pods contained in the Backup.
final
- resourceCount → int
-
The total number of Kubernetes resources included in the Backup.
final
- retainDays → int
-
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.
final
- retainExpireTime → String
-
The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectedApplications → NamespacedNamesResponse
-
If set, the list of ProtectedApplications whose resources were included in the Backup.
final
- selectedNamespaces → NamespacesResponse
-
If set, the list of namespaces that were included in the Backup.
final
- sizeBytes → String
-
The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
final
- state → String
-
Current state of the Backup
final
- stateReason → String
-
Human-readable description of why the backup is in the current
state.final - uid → String
-
Server generated global unique identifier of UUID4
final
- updateTime → String
-
The timestamp when this Backup resource was last updated.
final
- volumeCount → int
-
The total number of volume backups contained in the Backup.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited