instant_snapshots

Creates, updates, deletes, gets or lists an instant_snapshots resource.

Overview

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

Fields

The following fields are returned by SELECT queries:

get
list
aggregated_list

Name	Datatype	Description
`id`	`string (uint64)`	Output only. [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 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`architecture`	`string`	Output only. [Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64. (ARCHITECTURE_UNSPECIFIED, ARM64, X86_64)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`diskSizeGb`	`string (int64)`	Output only. [Output Only] Size of the source disk, specified in GB.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshot for InstantSnapshot resources. (default: compute#instantSnapshot)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this InstantSnapshot, 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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
`labels`	`object`	Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
`params`	`object`	Input only. Additional params passed with the request, but not persisted as part of resource payload. (id: InstantSnapshotParams)
`region`	`string`	Output only. [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`resourceStatus`	`object`	Output only. [Output Only] Status information for the instant snapshot resource. (id: InstantSnapshotResourceStatus)
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. [Output Only] Reserved for future use.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.
`selfLinkWithId`	`string`	Output only. [Output Only] Server-defined URL for this resource's resource id.
`sourceDisk`	`string`	URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
`sourceDiskId`	`string`	Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
`sourceInstantSnapshotGroup`	`string`	Output only. [Output Only] URL of the source instant snapshot this instant snapshot is part of. Note that the source instant snapshot group must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL.
`sourceInstantSnapshotGroupId`	`string`	Output only. [Output Only] The ID value of the source instant snapshot group this InstantSnapshot is part of. This value may be used to determine whether the InstantSnapshot was created as part of an InstantSnapshotGroup creation.
`status`	`string`	Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. (CREATING, DELETING, FAILED, READY, UNAVAILABLE)
`zone`	`string`	Output only. [Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of InstantSnapshot resources.
`kind`	`string`	Output only. Type of resource. (default: compute#instantSnapshotList)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Name	Datatype	Description
`id`	`string (uint64)`	Output only. [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 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`architecture`	`string`	Output only. [Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64. (ARCHITECTURE_UNSPECIFIED, ARM64, X86_64)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`diskSizeGb`	`string (int64)`	Output only. [Output Only] Size of the source disk, specified in GB.
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshot for InstantSnapshot resources. (default: compute#instantSnapshot)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this InstantSnapshot, 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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
`labels`	`object`	Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
`params`	`object`	Input only. Additional params passed with the request, but not persisted as part of resource payload. (id: InstantSnapshotParams)
`region`	`string`	Output only. [Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`resourceStatus`	`object`	Output only. [Output Only] Status information for the instant snapshot resource. (id: InstantSnapshotResourceStatus)
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. [Output Only] Reserved for future use.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.
`selfLinkWithId`	`string`	Output only. [Output Only] Server-defined URL for this resource's resource id.
`sourceDisk`	`string`	URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
`sourceDiskId`	`string`	Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
`sourceInstantSnapshotGroup`	`string`	Output only. [Output Only] URL of the source instant snapshot this instant snapshot is part of. Note that the source instant snapshot group must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL.
`sourceInstantSnapshotGroupId`	`string`	Output only. [Output Only] The ID value of the source instant snapshot group this InstantSnapshot is part of. This value may be used to determine whether the InstantSnapshot was created as part of an InstantSnapshotGroup creation.
`status`	`string`	Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY. (CREATING, DELETING, FAILED, READY, UNAVAILABLE)
`zone`	`string`	Output only. [Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `region`, `instantSnapshot`		Returns the specified InstantSnapshot resource in the specified region.
`list`	`select`	`project`, `region`	`orderBy`, `maxResults`, `pageToken`, `filter`, `returnPartialSuccess`	Retrieves the list of InstantSnapshot resources contained within the specified region.
`aggregated_list`	`select`	`project`	`returnPartialSuccess`, `includeAllScopes`, `orderBy`, `filter`, `serviceProjectNumber`, `maxResults`, `pageToken`	Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`insert`	`insert`	`project`, `region`	`requestId`	Creates an instant snapshot in the specified region.
`delete`	`delete`	`project`, `region`, `instantSnapshot`	`requestId`	Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, seeDeleting instantSnapshots.
`set_labels`	`exec`	`project`, `region`, `resource`	`requestId`	Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`instantSnapshot`	`string`
`project`	`string`
`region`	`string`
`resource`	`string`
`filter`	`string`
`includeAllScopes`	`boolean`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`serviceProjectNumber`	`string (int64)`

`SELECT` examples

get
list
aggregated_list

Returns the specified InstantSnapshot resource in the specified region.

SELECT
id,
name,
architecture,
creationTimestamp,
description,
diskSizeGb,
kind,
labelFingerprint,
labels,
params,
region,
resourceStatus,
satisfiesPzi,
satisfiesPzs,
selfLink,
selfLinkWithId,
sourceDisk,
sourceDiskId,
sourceInstantSnapshotGroup,
sourceInstantSnapshotGroupId,
status,
zone
FROM google.compute.instant_snapshots
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND instantSnapshot = '{{ instantSnapshot }}' -- required
;

Retrieves the list of InstantSnapshot resources contained within
the specified region.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.instant_snapshots
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

Retrieves an aggregated list of instantSnapshots.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
architecture,
creationTimestamp,
description,
diskSizeGb,
kind,
labelFingerprint,
labels,
params,
region,
resourceStatus,
satisfiesPzi,
satisfiesPzs,
selfLink,
selfLinkWithId,
sourceDisk,
sourceDiskId,
sourceInstantSnapshotGroup,
sourceInstantSnapshotGroupId,
status,
zone
FROM google.compute.instant_snapshots
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
;

`INSERT` examples

insert
Manifest

Creates an instant snapshot in the specified region.

INSERT INTO google.compute.instant_snapshots (
data__params,
data__name,
data__labelFingerprint,
data__description,
data__labels,
data__sourceDisk,
project,
region,
requestId
)
SELECT 
'{{ params }}',
'{{ name }}',
'{{ labelFingerprint }}',
'{{ description }}',
'{{ labels }}',
'{{ sourceDisk }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: instant_snapshots
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the instant_snapshots resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the instant_snapshots resource.
  - name: params
    description: |
      Input only. Additional params passed with the request, but not persisted
      as part of resource payload.
    value:
      resourceManagerTags: "{{ resourceManagerTags }}"
  - name: name
    value: "{{ name }}"
    description: |
      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.
  - name: labelFingerprint
    value: "{{ labelFingerprint }}"
    description: |
      A fingerprint for the labels being applied to this InstantSnapshot, 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 error412 conditionNotMet.
      To see the latest fingerprint, make a get() request to
      retrieve a InstantSnapshot.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Labels to apply to this InstantSnapshot. These can be later modified by
      the setLabels method.
      Label values may be empty.
  - name: sourceDisk
    value: "{{ sourceDisk }}"
    description: |
      URL of the source disk used to create this instant snapshot.
      Note that the source disk must be in the same zone/region as the
      instant snapshot to be created. This can be a full or valid partial URL.
      For example, the following are valid values:
      -
      https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
      -
      https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
      -
      projects/project/zones/zone/disks/disk
      -
      projects/project/regions/region/disks/disk
      -
      zones/zone/disks/disk
      -
      regions/region/disks/disk
  - name: requestId
    value: "{{ requestId }}"

`DELETE` examples

delete

Deletes the specified InstantSnapshot resource. Keep in mind that deleting
a single instantSnapshot might not necessarily delete all the data on that
instantSnapshot. If any data on the instantSnapshot that is marked for
deletion is needed for subsequent instantSnapshots, the data will be moved
to the next corresponding instantSnapshot.

For more information, seeDeleting
instantSnapshots.

DELETE FROM google.compute.instant_snapshots
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND instantSnapshot = '{{ instantSnapshot }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

set_labels

Sets the labels on a instantSnapshot in the given region. To learn more
about labels, read the Labeling
Resources documentation.

EXEC google.compute.instant_snapshots.set_labels 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@resource='{{ resource }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"labels": "{{ labels }}", 
"labelFingerprint": "{{ labelFingerprint }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​

Lifecycle Methods​