snapshots

Creates, updates, deletes, gets or lists a snapshots resource.

Overview

Name	`snapshots`
Type	Resource
Id	`google.compute.snapshots`

Fields

Name	Datatype	Description
`id`	`string`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`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.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`architecture`	`string`	[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
`autoCreated`	`boolean`	[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
`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.
`creationSizeBytes`	`string`	[Output Only] Size in bytes of the snapshot at creation time.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`diskSizeGb`	`string`	[Output Only] Size of the source disk, specified in GB.
`downloadBytes`	`string`	[Output Only] Number of bytes downloaded to restore a snapshot to a disk.
`enableConfidentialCompute`	`boolean`	Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
`guestOsFeatures`	`array`	[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.
`kind`	`string`	[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
`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.
`labels`	`object`	Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
`licenseCodes`	`array`	[Output Only] Integer license codes indicating which licenses are attached to this snapshot.
`licenses`	`array`	[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).
`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.
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	[Output Only] Reserved for future use.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`snapshotEncryptionKey`	`object`
`snapshotType`	`string`	Indicates the type of the snapshot.
`sourceDisk`	`string`	The source disk used to create this snapshot.
`sourceDiskEncryptionKey`	`object`
`sourceDiskForRecoveryCheckpoint`	`string`	The source disk whose recovery checkpoint will be used to create this snapshot.
`sourceDiskId`	`string`	[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.
`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
`sourceInstantSnapshotEncryptionKey`	`object`
`sourceInstantSnapshotId`	`string`	[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.
`sourceSnapshotSchedulePolicy`	`string`	[Output Only] URL of the resource policy which created this scheduled snapshot.
`sourceSnapshotSchedulePolicyId`	`string`	[Output Only] ID of the resource policy which created this scheduled snapshot.
`status`	`string`	[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
`storageBytes`	`string`	[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.
`storageBytesStatus`	`string`	[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.
`storageLocations`	`array`	Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

Methods

Name	Accessible by	Required Params	Description
`get`	`SELECT`	`project, snapshot`	Returns the specified Snapshot resource.
`list`	`SELECT`	`project`	Retrieves the list of Snapshot resources contained within the specified project.
`insert`	`INSERT`	`project`	Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.
`delete`	`DELETE`	`project, snapshot`	Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.
`set_labels`	`EXEC`	`project, resource`	Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.

`SELECT` examples

Retrieves the list of Snapshot resources contained within the specified project.

SELECT
id,
name,
description,
architecture,
autoCreated,
chainName,
creationSizeBytes,
creationTimestamp,
diskSizeGb,
downloadBytes,
enableConfidentialCompute,
guestOsFeatures,
kind,
labelFingerprint,
labels,
licenseCodes,
licenses,
locationHint,
satisfiesPzi,
satisfiesPzs,
selfLink,
snapshotEncryptionKey,
snapshotType,
sourceDisk,
sourceDiskEncryptionKey,
sourceDiskForRecoveryCheckpoint,
sourceDiskId,
sourceInstantSnapshot,
sourceInstantSnapshotEncryptionKey,
sourceInstantSnapshotId,
sourceSnapshotSchedulePolicy,
sourceSnapshotSchedulePolicyId,
status,
storageBytes,
storageBytesStatus,
storageLocations
FROM google.compute.snapshots
WHERE project = '{{ project }}';

`INSERT` example

Use the following StackQL query and manifest file to create a new snapshots resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.compute.snapshots (
project,
name,
description,
status,
sourceDisk,
sourceDiskId,
diskSizeGb,
storageBytes,
storageBytesStatus,
licenses,
snapshotEncryptionKey,
sourceDiskEncryptionKey,
labels,
labelFingerprint,
licenseCodes,
storageLocations,
autoCreated,
guestOsFeatures,
downloadBytes,
chainName,
satisfiesPzs,
locationHint,
sourceSnapshotSchedulePolicy,
sourceSnapshotSchedulePolicyId,
sourceInstantSnapshot,
sourceInstantSnapshotId,
architecture,
snapshotType,
creationSizeBytes,
enableConfidentialCompute,
sourceDiskForRecoveryCheckpoint,
sourceInstantSnapshotEncryptionKey
)
SELECT 
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ status }}',
'{{ sourceDisk }}',
'{{ sourceDiskId }}',
'{{ diskSizeGb }}',
'{{ storageBytes }}',
'{{ storageBytesStatus }}',
'{{ licenses }}',
'{{ snapshotEncryptionKey }}',
'{{ sourceDiskEncryptionKey }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ licenseCodes }}',
'{{ storageLocations }}',
{{ autoCreated }},
'{{ guestOsFeatures }}',
'{{ downloadBytes }}',
'{{ chainName }}',
{{ satisfiesPzs }},
'{{ locationHint }}',
'{{ sourceSnapshotSchedulePolicy }}',
'{{ sourceSnapshotSchedulePolicyId }}',
'{{ sourceInstantSnapshot }}',
'{{ sourceInstantSnapshotId }}',
'{{ architecture }}',
'{{ snapshotType }}',
'{{ creationSizeBytes }}',
{{ enableConfidentialCompute }},
'{{ sourceDiskForRecoveryCheckpoint }}',
'{{ sourceInstantSnapshotEncryptionKey }}'
;

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: status
      value: string
    - name: sourceDisk
      value: string
    - name: sourceDiskId
      value: string
    - name: diskSizeGb
      value: string
    - name: storageBytes
      value: string
    - name: storageBytesStatus
      value: string
    - name: licenses
      value:
        - string
    - name: snapshotEncryptionKey
      value:
        - name: rawKey
          value: string
        - name: rsaEncryptedKey
          value: string
        - name: kmsKeyName
          value: string
        - name: sha256
          value: string
        - name: kmsKeyServiceAccount
          value: string
    - name: selfLink
      value: string
    - name: labels
      value: object
    - name: labelFingerprint
      value: string
    - name: licenseCodes
      value:
        - string
    - name: storageLocations
      value:
        - string
    - name: autoCreated
      value: boolean
    - name: guestOsFeatures
      value:
        - - name: type
            value: string
    - name: downloadBytes
      value: string
    - name: chainName
      value: string
    - name: satisfiesPzs
      value: boolean
    - name: locationHint
      value: string
    - name: sourceSnapshotSchedulePolicy
      value: string
    - name: sourceSnapshotSchedulePolicyId
      value: string
    - name: sourceInstantSnapshot
      value: string
    - name: sourceInstantSnapshotId
      value: string
    - name: architecture
      value: string
    - name: snapshotType
      value: string
    - name: creationSizeBytes
      value: string
    - name: enableConfidentialCompute
      value: boolean
    - name: sourceDiskForRecoveryCheckpoint
      value: string
    - name: satisfiesPzi
      value: boolean

`DELETE` example

Deletes the specified snapshots resource.

/*+ delete */
DELETE FROM google.compute.snapshots
WHERE project = '{{ project }}'
AND snapshot = '{{ snapshot }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​