Class Snapshot

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.

Inheritance
object
Snapshot
Implements
Inherited Members
Namespace: Google.Apis.Compute.alpha.Data
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class Snapshot : IDirectResponseSchema

Properties

Architecture

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.

Declaration
[JsonProperty("architecture")]
public virtual string Architecture { get; set; }
Property Value
Type Description
string

AutoCreated

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

Declaration
[JsonProperty("autoCreated")]
public virtual bool? AutoCreated { get; set; }
Property Value
Type Description
bool?

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.

Declaration
[JsonProperty("chainName")]
public virtual string ChainName { get; set; }
Property Value
Type Description
string

CreationSizeBytes

[Output Only] Size in bytes of the snapshot at creation time.

Declaration
[JsonProperty("creationSizeBytes")]
public virtual long? CreationSizeBytes { get; set; }
Property Value
Type Description
long?

CreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type Description
string

Description

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

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

DiskSizeGb

[Output Only] Size of the source disk, specified in GB.

Declaration
[JsonProperty("diskSizeGb")]
public virtual long? DiskSizeGb { get; set; }
Property Value
Type Description
long?

DownloadBytes

[Output Only] Number of bytes downloaded to restore a snapshot to a disk.

Declaration
[JsonProperty("downloadBytes")]
public virtual long? DownloadBytes { get; set; }
Property Value
Type Description
long?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("enableConfidentialCompute")]
public virtual bool? EnableConfidentialCompute { get; set; }
Property Value
Type Description
bool?

GuestFlush

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

Declaration
[JsonProperty("guestFlush")]
public virtual bool? GuestFlush { get; set; }
Property Value
Type Description
bool?

GuestOsFeatures

[Output Only] 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.

Declaration
[JsonProperty("guestOsFeatures")]
public virtual IList<GuestOsFeature> GuestOsFeatures { get; set; }
Property Value
Type Description
IList<GuestOsFeature>

Id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type Description
ulong?

Kind

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("labelFingerprint")]
public virtual string LabelFingerprint { get; set; }
Property Value
Type Description
string

Labels

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

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

LicenseCodes

[Output Only] Integer license codes indicating which licenses are attached to this snapshot.

Declaration
[JsonProperty("licenseCodes")]
public virtual IList<long?> LicenseCodes { get; set; }
Property Value
Type Description
IList<long?>

Licenses

[Output Only] 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).

Declaration
[JsonProperty("licenses")]
public virtual IList<string> Licenses { get; set; }
Property Value
Type Description
IList<string>

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.

Declaration
[JsonProperty("locationHint")]
public virtual string LocationHint { get; set; }
Property Value
Type Description
string

MaxRetentionDays

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

Declaration
[JsonProperty("maxRetentionDays")]
public virtual int? MaxRetentionDays { get; set; }
Property Value
Type Description
int?

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Region

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

Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
Type Description
string

ResourceStatus

[Output only] ResourceStatus of the Snapshot resource

Declaration
[JsonProperty("resourceStatus")]
public virtual SnapshotResourceStatus ResourceStatus { get; set; }
Property Value
Type Description
SnapshotResourceStatus

SatisfiesPzi

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

[Output Only] Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

[Output Only] Server-defined URL for the resource.

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
string

SelfLinkWithId

[Output Only] Server-defined URL for this resource's resource id.

Declaration
[JsonProperty("selfLinkWithId")]
public virtual string SelfLinkWithId { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("snapshotEncryptionKey")]
public virtual CustomerEncryptionKey SnapshotEncryptionKey { get; set; }
Property Value
Type Description
CustomerEncryptionKey

SnapshotType

Indicates the type of the snapshot.

Declaration
[JsonProperty("snapshotType")]
public virtual string SnapshotType { get; set; }
Property Value
Type Description
string

SourceDisk

The source disk used to create this snapshot.

Declaration
[JsonProperty("sourceDisk")]
public virtual string SourceDisk { get; set; }
Property Value
Type Description
string

SourceDiskEncryptionKey

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

Declaration
[JsonProperty("sourceDiskEncryptionKey")]
public virtual CustomerEncryptionKey SourceDiskEncryptionKey { get; set; }
Property Value
Type Description
CustomerEncryptionKey

SourceDiskForRecoveryCheckpoint

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

Declaration
[JsonProperty("sourceDiskForRecoveryCheckpoint")]
public virtual string SourceDiskForRecoveryCheckpoint { get; set; }
Property Value
Type Description
string

SourceDiskId

[Output Only] 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.

Declaration
[JsonProperty("sourceDiskId")]
public virtual string SourceDiskId { get; set; }
Property Value
Type Description
string

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

Declaration
[JsonProperty("sourceInstantSnapshot")]
public virtual string SourceInstantSnapshot { get; set; }
Property Value
Type Description
string

SourceInstantSnapshotEncryptionKey

Customer provided encryption key when creating Snapshot from Instant Snapshot.

Declaration
[JsonProperty("sourceInstantSnapshotEncryptionKey")]
public virtual CustomerEncryptionKey SourceInstantSnapshotEncryptionKey { get; set; }
Property Value
Type Description
CustomerEncryptionKey

SourceInstantSnapshotId

[Output Only] 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.

Declaration
[JsonProperty("sourceInstantSnapshotId")]
public virtual string SourceInstantSnapshotId { get; set; }
Property Value
Type Description
string

SourceSnapshotSchedulePolicy

[Output Only] URL of the resource policy which created this scheduled snapshot.

Declaration
[JsonProperty("sourceSnapshotSchedulePolicy")]
public virtual string SourceSnapshotSchedulePolicy { get; set; }
Property Value
Type Description
string

SourceSnapshotSchedulePolicyId

[Output Only] ID of the resource policy which created this scheduled snapshot.

Declaration
[JsonProperty("sourceSnapshotSchedulePolicyId")]
public virtual string SourceSnapshotSchedulePolicyId { get; set; }
Property Value
Type Description
string

Status

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

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

StorageBytes

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

Declaration
[JsonProperty("storageBytes")]
public virtual long? StorageBytes { get; set; }
Property Value
Type Description
long?

StorageBytesStatus

[Output Only] 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.

Declaration
[JsonProperty("storageBytesStatus")]
public virtual string StorageBytesStatus { get; set; }
Property Value
Type Description
string

StorageLocations

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

Declaration
[JsonProperty("storageLocations")]
public virtual IList<string> StorageLocations { get; set; }
Property Value
Type Description
IList<string>

UserLicenses

[Output Only] A list of user provided licenses represented by a list of URLs to the license resource.

Declaration
[JsonProperty("userLicenses")]
public virtual IList<string> UserLicenses { get; set; }
Property Value
Type Description
IList<string>

Implements