Snapshot class

Represents a Persistent Disk Snapshot resource.

You can use snapshots to back up data on a regular interval.

For more information, read Creating persistent disk snapshots.

Constructors

Snapshot({String? architecture, bool? autoCreated, String? chainName, String? creationSizeBytes, String? creationTimestamp, String? description, String? diskSizeGb, String? downloadBytes, bool? enableConfidentialCompute, bool? guestFlush, List<GuestOsFeature>? guestOsFeatures, String? id, String? kind, String? labelFingerprint, Map<String, String>? labels, List<String>? licenseCodes, List<String>? licenses, String? locationHint, String? name, SnapshotParams? params, String? region, bool? satisfiesPzi, bool? satisfiesPzs, String? selfLink, CustomerEncryptionKey? snapshotEncryptionKey, String? snapshotGroupId, String? snapshotGroupName, String? snapshotType, String? sourceDisk, CustomerEncryptionKey? sourceDiskEncryptionKey, String? sourceDiskForRecoveryCheckpoint, String? sourceDiskId, String? sourceInstantSnapshot, CustomerEncryptionKey? sourceInstantSnapshotEncryptionKey, String? sourceInstantSnapshotId, String? sourceSnapshotSchedulePolicy, String? sourceSnapshotSchedulePolicyId, String? status, String? storageBytes, String? storageBytesStatus, List<String>? storageLocations})
Snapshot.fromJson(Map json_)

Properties

architecture ↔ String?
The architecture of the snapshot.
getter/setter pair
autoCreated ↔ bool?
Set to true if snapshots are automatically created by applying resource policy on the target disk.
getter/setter pair
chainName ↔ String?
Creates the new snapshot in the snapshot chain labeled with the specified name.
getter/setter pair
creationSizeBytes ↔ String?
Size in bytes of the snapshot at creation time.
getter/setter pair
creationTimestamp ↔ String?
Creation timestamp inRFC3339 text format.
getter/setter pair
description ↔ String?
An optional description of this resource.
getter/setter pair
diskSizeGb ↔ String?
Size of the source disk, specified in GB.
getter/setter pair
downloadBytes ↔ String?
Number of bytes downloaded to restore a snapshot to a disk.
getter/setter pair
enableConfidentialCompute ↔ bool?
Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
getter/setter pair
guestFlush ↔ bool?
[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
getter/setter pair
guestOsFeatures ↔ List<GuestOsFeature>?
A list of features to enable on the guest operating system. Applicable only for bootable images.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
The unique identifier for the resource.
getter/setter pair
kind ↔ String?
Type of the resource.
getter/setter pair
labelFingerprint ↔ String?
A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking.
getter/setter pair
labelFingerprintAsBytes ↔ List<int>
getter/setter pair
labels ↔ Map<String, String>?
Labels to apply to this snapshot.
getter/setter pair
licenseCodes ↔ List<String>?
Integer license codes indicating which licenses are attached to this snapshot.
getter/setter pair
licenses ↔ List<String>?
A list of public visible licenses that apply to this snapshot.
getter/setter pair
locationHint ↔ String?
An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.
getter/setter pair
name ↔ String?
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
getter/setter pair
params ↔ SnapshotParams?
Input only.
getter/setter pair
region ↔ String?
URL of the region where the snapshot resides.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzi ↔ bool?
Reserved for future use.
getter/setter pair
satisfiesPzs ↔ bool?
Reserved for future use.
getter/setter pair
Server-defined URL for the resource.
getter/setter pair
snapshotEncryptionKey ↔ CustomerEncryptionKey?
Encrypts the snapshot using acustomer-supplied encryption key.
getter/setter pair
snapshotGroupId ↔ String?
The unique ID of the snapshot group that this snapshot belongs to.
getter/setter pair
snapshotGroupName ↔ String?
The snapshot group that this snapshot belongs to.
getter/setter pair
snapshotType ↔ String?
Indicates the type of the snapshot. Possible string values are:
getter/setter pair
sourceDisk ↔ String?
The source disk used to create this snapshot.
getter/setter pair
sourceDiskEncryptionKey ↔ CustomerEncryptionKey?
The customer-supplied encryption key of the source disk.
getter/setter pair
sourceDiskForRecoveryCheckpoint ↔ String?
The source disk whose recovery checkpoint will be used to create this snapshot.
getter/setter pair
sourceDiskId ↔ String?
The ID value of the disk used to create this snapshot.
getter/setter pair
sourceInstantSnapshot ↔ String?
The source instant snapshot used to create this snapshot.
getter/setter pair
sourceInstantSnapshotEncryptionKey ↔ CustomerEncryptionKey?
Customer provided encryption key when creating Snapshot from Instant Snapshot.
getter/setter pair
sourceInstantSnapshotId ↔ String?
The unique ID of the instant snapshot used to create this snapshot.
getter/setter pair
sourceSnapshotSchedulePolicy ↔ String?
URL of the resource policy which created this scheduled snapshot.
getter/setter pair
sourceSnapshotSchedulePolicyId ↔ String?
ID of the resource policy which created this scheduled snapshot.
getter/setter pair
status ↔ String?
The status of the snapshot.
getter/setter pair
storageBytes ↔ String?
A size of the storage used by the snapshot.
getter/setter pair
storageBytesStatus ↔ String?
Instead, check the storageBytes field.
getter/setter pair
storageLocations ↔ List<String>?
Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited