instant_snapshot_groups

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

Overview

Name	instant_snapshot_groups
Type	Resource
Id	google.compute.instant_snapshot_groups

Fields

The following fields are returned by SELECT queries:

get

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	Identifier. 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])?)
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	Optional. An optional description of this resource. Provide this property when you create the resource.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup resources. (default: compute#instantSnapshotGroup)
region	string	Output only. [Output Only] URL of the region where the instant snapshot group 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	(id: InstantSnapshotGroupResourceStatus)
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.
sourceConsistencyGroup	string
status	string	Output only. [Output Only] (CREATING, DELETING, FAILED, INVALID, READY, UNKNOWN)
zone	string	Output only. [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
etag	string
items	array	A list of InstantSnapshotGroup resources.
kind	string	Output only. Type of resource. (default: compute#instantSnapshotGroupsList)
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.
unreachables	array	Output only. [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, zone, instantSnapshotGroup		returns the specified InstantSnapshotGroup resource in the specified zone.
list	select	project, zone	orderBy, maxResults, pageToken, filter, returnPartialSuccess	retrieves the list of InstantSnapshotGroup resources contained within the specified zone.
insert	insert	project, zone	sourceConsistencyGroup, requestId	inserts a Zonal InstantSnapshotGroup resource
delete	delete	project, zone, instantSnapshotGroup	requestId	deletes a Zonal InstantSnapshotGroup resource

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
instantSnapshotGroup	string
project	string
zone	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
sourceConsistencyGroup	string

SELECT examples

get

returns the specified InstantSnapshotGroup resource in the specified zone.

SELECT
id,
name,
creationTimestamp,
description,
kind,
region,
resourceStatus,
selfLink,
selfLinkWithId,
sourceConsistencyGroup,
status,
zone
FROM google.compute.instant_snapshot_groups
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND instantSnapshotGroup = '{{ instantSnapshotGroup }}' -- required
;

list

retrieves the list of InstantSnapshotGroup resources contained within
the specified zone.

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

INSERT examples

insert

inserts a Zonal InstantSnapshotGroup resource

INSERT INTO google.compute.instant_snapshot_groups (
data__sourceConsistencyGroup,
data__description,
data__name,
project,
zone,
sourceConsistencyGroup,
requestId
)
SELECT 
'{{ sourceConsistencyGroup }}',
'{{ description }}',
'{{ name }}',
'{{ project }}',
'{{ zone }}',
'{{ sourceConsistencyGroup }}',
'{{ 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
;

Manifest

# Description fields are for documentation purposes
- name: instant_snapshot_groups
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the instant_snapshot_groups resource.
  - name: zone
    value: "{{ zone }}"
    description: Required parameter for the instant_snapshot_groups resource.
  - name: sourceConsistencyGroup
    value: "{{ sourceConsistencyGroup }}"
  - name: description
    value: "{{ description }}"
    description: |
      Optional. An optional description of this resource. Provide this property when you
      create the resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. 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: sourceConsistencyGroup
    value: "{{ sourceConsistencyGroup }}"
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

deletes a Zonal InstantSnapshotGroup resource

DELETE FROM google.compute.instant_snapshot_groups
WHERE project = '{{ project }}' --required
AND zone = '{{ zone }}' --required
AND instantSnapshotGroup = '{{ instantSnapshotGroup }}' --required
AND requestId = '{{ requestId }}'
;