GetSnapshotResult class

Result data returned by getSnapshot.

Constructors

GetSnapshotResult({required String architecture, required bool autoCreated, required String chainName, required String creationSizeBytes, required String creationTimestamp, required String description, required String diskSizeGb, required String downloadBytes, required bool enableConfidentialCompute, required bool guestFlush, required List<GuestOsFeatureResponse> guestOsFeatures, required String kind, required String labelFingerprint, required Map<String, String> labels, required List<String> licenseCodes, required List<String> licenses, required String locationHint, required int maxRetentionDays, required String name, required String region, required bool satisfiesPzs, required String selfLink, required String selfLinkWithId, required CustomerEncryptionKeyResponse snapshotEncryptionKey, required String snapshotType, required String sourceDisk, required CustomerEncryptionKeyResponse sourceDiskEncryptionKey, required String sourceDiskForRecoveryCheckpoint, required String sourceDiskId, required String sourceInstantSnapshot, required CustomerEncryptionKeyResponse sourceInstantSnapshotEncryptionKey, required String sourceInstantSnapshotId, required String sourceSnapshotSchedulePolicy, required String sourceSnapshotSchedulePolicyId, required String status, required String storageBytes, required String storageBytesStatus, required List<String> storageLocations, required List<String> userLicenses})

Creates a new GetSnapshotResult. architecture The architecture of the snapshot. Valid values are ARM64 or X86_64. autoCreated Set to true if snapshots are automatically created by applying resource policy on the target disk. chainName Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. creationSizeBytes Size in bytes of the snapshot at creation time. creationTimestamp Creation timestamp in RFC3339 text format. description An optional description of this resource. Provide this property when you create the resource. diskSizeGb Size of the source disk, specified in GB. downloadBytes Number of bytes downloaded to restore a snapshot to a disk. enableConfidentialCompute Whether this snapshot is created from a confidential compute mode disk. Output Only: This field is not set by user, but from source disk. guestFlush Input Only Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. guestOsFeatures A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. kind Type of the resource. Always compute#snapshot for Snapshot resources. labelFingerprint A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. labels Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. licenseCodes Integer license codes indicating which licenses are attached to this snapshot. licenses A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). locationHint 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. maxRetentionDays Number of days the snapshot should be retained before being deleted automatically. name Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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. region URL of the region where the snapshot resides. Only applicable for regional snapshots. satisfiesPzs Reserved for future use. selfLink Server-defined URL for the resource. selfLinkWithId Server-defined URL for this resource's resource id. snapshotEncryptionKey Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. snapshotType Indicates the type of the snapshot. sourceDisk The source disk used to create this snapshot. sourceDiskEncryptionKey The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. sourceDiskForRecoveryCheckpoint The source disk whose recovery checkpoint will be used to create this snapshot. sourceDiskId The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. sourceInstantSnapshot The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot sourceInstantSnapshotEncryptionKey Customer provided encryption key when creating Snapshot from Instant Snapshot. sourceInstantSnapshotId The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. sourceSnapshotSchedulePolicy URL of the resource policy which created this scheduled snapshot. sourceSnapshotSchedulePolicyId ID of the resource policy which created this scheduled snapshot. status The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. storageBytes A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. storageBytesStatus An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. storageLocations Cloud Storage bucket storage location of the snapshot (regional or multi-regional). userLicenses A list of user provided licenses represented by a list of URLs to the license resource.

const

GetSnapshotResult.fromMap(Map<String, dynamic> map)

factory

Properties

architecture → String

The architecture of the snapshot. Valid values are ARM64 or X86_64.

final

autoCreated → bool

Set to true if snapshots are automatically created by applying resource policy on the target disk.

final

chainName → String

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

final

creationSizeBytes → String

Size in bytes of the snapshot at creation time.

final

creationTimestamp → String

Creation timestamp in RFC3339 text format.

final

description → String

An optional description of this resource. Provide this property when you create the resource.

final

diskSizeGb → String

Size of the source disk, specified in GB.

final

downloadBytes → String

Number of bytes downloaded to restore a snapshot to a disk.

final

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.

final

guestFlush → bool

Input Only Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.

final

guestOsFeatures → List<GuestOsFeatureResponse>

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

final

hashCode → int

The hash code for this object.

no setter, inherited

kind → String

Type of the resource. Always compute#snapshot for Snapshot resources.

final

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. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.

final

labels → Map<String, String>

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

final

licenseCodes → List<String>

Integer license codes indicating which licenses are attached to this snapshot.

final

licenses → List<String>

A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

final

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.

final

maxRetentionDays → int

Number of days the snapshot should be retained before being deleted automatically.

final

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 with RFC1035. 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.

final

region → String

URL of the region where the snapshot resides. Only applicable for regional snapshots.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

satisfiesPzs → bool

Reserved for future use.

final

selfLink → String

Server-defined URL for the resource.

final

selfLinkWithId → String

Server-defined URL for this resource's resource id.

final

snapshotEncryptionKey → CustomerEncryptionKeyResponse

Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.

final

snapshotType → String

Indicates the type of the snapshot.

final

sourceDisk → String

The source disk used to create this snapshot.

final

sourceDiskEncryptionKey → CustomerEncryptionKeyResponse

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

final

sourceDiskForRecoveryCheckpoint → String

The source disk whose recovery checkpoint will be used to create this snapshot.

final

sourceDiskId → String

The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

final

sourceInstantSnapshot → String

The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

final

sourceInstantSnapshotEncryptionKey → CustomerEncryptionKeyResponse

Customer provided encryption key when creating Snapshot from Instant Snapshot.

final

sourceInstantSnapshotId → String

The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.

final

sourceSnapshotSchedulePolicy → String

URL of the resource policy which created this scheduled snapshot.

final

sourceSnapshotSchedulePolicyId → String

ID of the resource policy which created this scheduled snapshot.

final

status → String

The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

final

storageBytes → String

A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

final

storageBytesStatus → String

An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

final

storageLocations → List<String>

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

final

userLicenses → List<String>

A list of user provided licenses represented by a list of URLs to the license resource.

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