public sealed class Snapshot : IMessage<Snapshot>, IEquatable<Snapshot>, IDeepCloneable<Snapshot>, IBufferMessage, IMessageReference documentation and code samples for the Compute Engine v1 API 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.
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Constructors
Snapshot()
public Snapshot()Snapshot(Snapshot)
public Snapshot(Snapshot other)| Parameter | |
|---|---|
| Name | Description |
other |
Snapshot |
Properties
Architecture
public string Architecture { get; set; }[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|
AutoCreated
public bool AutoCreated { get; set; }[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
ChainName
public string ChainName { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CreationSizeBytes
public long CreationSizeBytes { get; set; }[Output Only] Size in bytes of the snapshot at creation time.
| Property Value | |
|---|---|
| Type | Description |
long |
|
CreationTimestamp
public string CreationTimestamp { get; set; }[Output Only] Creation timestamp in RFC3339 text format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Description
public string Description { get; set; }An optional description of this resource. Provide this property when you create the resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DiskSizeGb
public long DiskSizeGb { get; set; }[Output Only] Size of the source disk, specified in GB.
| Property Value | |
|---|---|
| Type | Description |
long |
|
DownloadBytes
public long DownloadBytes { get; set; }[Output Only] Number of bytes downloaded to restore a snapshot to a disk.
| Property Value | |
|---|---|
| Type | Description |
long |
|
EnableConfidentialCompute
public bool EnableConfidentialCompute { get; set; }Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
GuestOsFeatures
public RepeatedField<GuestOsFeature> GuestOsFeatures { get; }[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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldGuestOsFeature |
|
HasArchitecture
public bool HasArchitecture { get; }Gets whether the "architecture" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasAutoCreated
public bool HasAutoCreated { get; }Gets whether the "auto_created" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasChainName
public bool HasChainName { get; }Gets whether the "chain_name" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasCreationSizeBytes
public bool HasCreationSizeBytes { get; }Gets whether the "creation_size_bytes" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasCreationTimestamp
public bool HasCreationTimestamp { get; }Gets whether the "creation_timestamp" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasDescription
public bool HasDescription { get; }Gets whether the "description" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasDiskSizeGb
public bool HasDiskSizeGb { get; }Gets whether the "disk_size_gb" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasDownloadBytes
public bool HasDownloadBytes { get; }Gets whether the "download_bytes" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasEnableConfidentialCompute
public bool HasEnableConfidentialCompute { get; }Gets whether the "enable_confidential_compute" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasId
public bool HasId { get; }Gets whether the "id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasKind
public bool HasKind { get; }Gets whether the "kind" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasLabelFingerprint
public bool HasLabelFingerprint { get; }Gets whether the "label_fingerprint" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasLocationHint
public bool HasLocationHint { get; }Gets whether the "location_hint" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasName
public bool HasName { get; }Gets whether the "name" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSatisfiesPzi
public bool HasSatisfiesPzi { get; }Gets whether the "satisfies_pzi" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSatisfiesPzs
public bool HasSatisfiesPzs { get; }Gets whether the "satisfies_pzs" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSelfLink
public bool HasSelfLink { get; }Gets whether the "self_link" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSnapshotType
public bool HasSnapshotType { get; }Gets whether the "snapshot_type" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSourceDisk
public bool HasSourceDisk { get; }Gets whether the "source_disk" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSourceDiskForRecoveryCheckpoint
public bool HasSourceDiskForRecoveryCheckpoint { get; }Gets whether the "source_disk_for_recovery_checkpoint" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSourceDiskId
public bool HasSourceDiskId { get; }Gets whether the "source_disk_id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSourceInstantSnapshot
public bool HasSourceInstantSnapshot { get; }Gets whether the "source_instant_snapshot" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSourceInstantSnapshotId
public bool HasSourceInstantSnapshotId { get; }Gets whether the "source_instant_snapshot_id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSourceSnapshotSchedulePolicy
public bool HasSourceSnapshotSchedulePolicy { get; }Gets whether the "source_snapshot_schedule_policy" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSourceSnapshotSchedulePolicyId
public bool HasSourceSnapshotSchedulePolicyId { get; }Gets whether the "source_snapshot_schedule_policy_id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasStatus
public bool HasStatus { get; }Gets whether the "status" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasStorageBytes
public bool HasStorageBytes { get; }Gets whether the "storage_bytes" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasStorageBytesStatus
public bool HasStorageBytesStatus { get; }Gets whether the "storage_bytes_status" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Id
public ulong Id { get; set; }[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Property Value | |
|---|---|
| Type | Description |
ulong |
|
Kind
public string Kind { get; set; }[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
| Property Value | |
|---|---|
| Type | Description |
string |
|
LabelFingerprint
public string LabelFingerprint { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Labels
public MapField<string, string> Labels { get; }Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
LicenseCodes
public RepeatedField<long> LicenseCodes { get; }[Output Only] Integer license codes indicating which licenses are attached to this snapshot.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldlong |
|
Licenses
public RepeatedField<string> Licenses { get; }[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).
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
LocationHint
public string LocationHint { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SatisfiesPzi
public bool SatisfiesPzi { get; set; }Output only. Reserved for future use.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
SatisfiesPzs
public bool SatisfiesPzs { get; set; }[Output Only] Reserved for future use.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
SelfLink
public string SelfLink { get; set; }[Output Only] Server-defined URL for the resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SnapshotEncryptionKey
public CustomerEncryptionKey SnapshotEncryptionKey { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
CustomerEncryptionKey |
|
SnapshotType
public string SnapshotType { get; set; }Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceDisk
public string SourceDisk { get; set; }The source disk used to create this snapshot.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceDiskEncryptionKey
public CustomerEncryptionKey SourceDiskEncryptionKey { get; set; }The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
| Property Value | |
|---|---|
| Type | Description |
CustomerEncryptionKey |
|
SourceDiskForRecoveryCheckpoint
public string SourceDiskForRecoveryCheckpoint { get; set; }The source disk whose recovery checkpoint will be used to create this snapshot.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceDiskId
public string SourceDiskId { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceInstantSnapshot
public string SourceInstantSnapshot { get; set; }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
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceInstantSnapshotEncryptionKey
public CustomerEncryptionKey SourceInstantSnapshotEncryptionKey { get; set; }Customer provided encryption key when creating Snapshot from Instant Snapshot.
| Property Value | |
|---|---|
| Type | Description |
CustomerEncryptionKey |
|
SourceInstantSnapshotId
public string SourceInstantSnapshotId { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceSnapshotSchedulePolicy
public string SourceSnapshotSchedulePolicy { get; set; }[Output Only] URL of the resource policy which created this scheduled snapshot.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SourceSnapshotSchedulePolicyId
public string SourceSnapshotSchedulePolicyId { get; set; }[Output Only] ID of the resource policy which created this scheduled snapshot.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Status
public string Status { get; set; }[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Check the Status enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|
StorageBytes
public long StorageBytes { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
long |
|
StorageBytesStatus
public string StorageBytesStatus { get; set; }[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. Check the StorageBytesStatus enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string |
|
StorageLocations
public RepeatedField<string> StorageLocations { get; }Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|