snapshots

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

Overview

Name	snapshots
Type	Resource
Id	google.dataflow.snapshots

Fields

The following fields are returned by SELECT queries:

projects_locations_snapshots_get

Successful response

Name	Datatype	Description
id	string	The unique ID of this snapshot.
creationTime	string (google-datetime)	The time this snapshot was created.
description	string	User specified description of the snapshot. Maybe empty.
diskSizeBytes	string (int64)	The disk byte size of the snapshot. Only available for snapshots in READY state.
projectId	string	The project this snapshot belongs to.
pubsubMetadata	array	Pub/Sub snapshot metadata.
region	string	Cloud region where this snapshot lives in, e.g., "us-central1".
sourceJobId	string	The job this snapshot was created from.
state	string	State of the snapshot.
ttl	string (google-duration)	The time after which this snapshot will be automatically deleted.

projects_locations_jobs_snapshots_list

Successful response

Name	Datatype	Description
snapshots	array	Returned snapshots.

projects_snapshots_get

Successful response

Name	Datatype	Description
id	string	The unique ID of this snapshot.
creationTime	string (google-datetime)	The time this snapshot was created.
description	string	User specified description of the snapshot. Maybe empty.
diskSizeBytes	string (int64)	The disk byte size of the snapshot. Only available for snapshots in READY state.
projectId	string	The project this snapshot belongs to.
pubsubMetadata	array	Pub/Sub snapshot metadata.
region	string	Cloud region where this snapshot lives in, e.g., "us-central1".
sourceJobId	string	The job this snapshot was created from.
state	string	State of the snapshot.
ttl	string (google-duration)	The time after which this snapshot will be automatically deleted.

projects_locations_snapshots_list

Successful response

Name	Datatype	Description
snapshots	array	Returned snapshots.

projects_snapshots_list

Successful response

Name	Datatype	Description
snapshots	array	Returned snapshots.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_snapshots_get	select	projectId, location, snapshotId		Gets information about a snapshot.
projects_locations_jobs_snapshots_list	select	projectId, location, jobId		Lists snapshots.
projects_snapshots_get	select	projectId, snapshotId	location	Gets information about a snapshot.
projects_locations_snapshots_list	select	projectId, location	jobId	Lists snapshots.
projects_snapshots_list	select	projectId	jobId, location	Lists snapshots.
projects_locations_snapshots_delete	delete	projectId, location, snapshotId		Deletes a snapshot.
projects_delete_snapshots	delete	projectId	snapshotId, location	Deletes a snapshot.

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
jobId	string
location	string
projectId	string
snapshotId	string
jobId	string
location	string
snapshotId	string

SELECT examples

projects_locations_snapshots_get

Gets information about a snapshot.

SELECT
id,
creationTime,
description,
diskSizeBytes,
projectId,
pubsubMetadata,
region,
sourceJobId,
state,
ttl
FROM google.dataflow.snapshots
WHERE projectId = '{{ projectId }}' -- required
AND location = '{{ location }}' -- required
AND snapshotId = '{{ snapshotId }}' -- required;

projects_locations_jobs_snapshots_list

Lists snapshots.

SELECT
snapshots
FROM google.dataflow.snapshots
WHERE projectId = '{{ projectId }}' -- required
AND location = '{{ location }}' -- required
AND jobId = '{{ jobId }}' -- required;

projects_snapshots_get

Gets information about a snapshot.

SELECT
id,
creationTime,
description,
diskSizeBytes,
projectId,
pubsubMetadata,
region,
sourceJobId,
state,
ttl
FROM google.dataflow.snapshots
WHERE projectId = '{{ projectId }}' -- required
AND snapshotId = '{{ snapshotId }}' -- required
AND location = '{{ location }}';

projects_locations_snapshots_list

Lists snapshots.

SELECT
snapshots
FROM google.dataflow.snapshots
WHERE projectId = '{{ projectId }}' -- required
AND location = '{{ location }}' -- required
AND jobId = '{{ jobId }}';

projects_snapshots_list

Lists snapshots.

SELECT
snapshots
FROM google.dataflow.snapshots
WHERE projectId = '{{ projectId }}' -- required
AND jobId = '{{ jobId }}'
AND location = '{{ location }}';

DELETE examples

projects_locations_snapshots_delete

Deletes a snapshot.

DELETE FROM google.dataflow.snapshots
WHERE projectId = '{{ projectId }}' --required
AND location = '{{ location }}' --required
AND snapshotId = '{{ snapshotId }}' --required;

projects_delete_snapshots

Deletes a snapshot.

DELETE FROM google.dataflow.snapshots
WHERE projectId = '{{ projectId }}' --required
AND snapshotId = '{{ snapshotId }}'
AND location = '{{ location }}';