Constructor

Snapshot

new Snapshot(scope, name)

A Snapshot object allows you to interact with a Google Compute Engine snapshot.

Parameter

scope

(Compute or Disk)

The parent scope this snapshot belongs to. If it's a Disk, we expose the create methods.

name

string

Snapshot name.

See also

Snapshots Overview

Snapshot Resource

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const snapshot = compute.snapshot('snapshot-name');

//-
// Or, access through a disk.
//-
const disk = compute.zone('us-central1-a').disk('disk-name');
const snapshot = disk.snapshot('disk-snapshot-name');

Properties

compute

Compute

id

string

name

string

Methods

create

create(config)

Create a snapshot.

This is only available if you accessed this object through Disk#snapshot.

Parameter

config

object

See Disk#createSnapshot.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const snapshot = compute.snapshot('snapshot-name');

snapshot.create(function(err, snapshot, operation, apiResponse) {
  // `snapshot` is a Snapshot object.

  // `operation` is an Operation object that can be used to check the
  // status of the request.
});

//-
// If the callback is omitted, we'll return a Promise.
//-
snapshot.create().then(function(data) {
  const snapshot = data[0];
  const operation = data[1];
  const apiResponse = data[2];
});

delete

delete(callback)

Delete the snapshot.

Parameter

callback

Optional

function()

The callback function.

See also

Snapshots: delete API Documentation

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const snapshot = compute.snapshot('snapshot-name');

snapshot.delete(function(err, operation, apiResponse) {
  // `operation` is an Operation object that can be used to check the status
  // of the request.
});

//-
// If the callback is omitted, we'll return a Promise.
//-
snapshot.delete().then(function(data) {
  const operation = data[0];
  const apiResponse = data[1];
});

exists

exists(callback)

Check if the snapshot exists.

Parameter

callback

function()

The callback function.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const snapshot = compute.snapshot('snapshot-name');

snapshot.exists(function(err, exists) {});

get

get(options)

Get a snapshot if it exists.

If you access this snapshot through a Disk object, this can be used as a "get or create" method. Pass an object with autoCreate set to true. Any extra configuration that is normally required for the create method must be contained within this object as well.

Parameter

options

Optional

options

Configuration object.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const snapshot = compute.snapshot('snapshot-name');

snapshot.get(function(err, snapshot, apiResponse) {
  // `snapshot` is a Snapshot object.
});

//-
// If the callback is omitted, we'll return a Promise.
//-
snapshot.get().then(function(data) {
  const snapshot = data[0];
  const apiResponse = data[1];
});

getMetadata

getMetadata(callback)

Get the snapshot's metadata.

Parameter

callback

Optional

function()

The callback function.

See also

Snapshot Resource

Snapshots: get API Documentation

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const snapshot = compute.snapshot('snapshot-name');

snapshot.getMetadata(function(err, metadata, apiResponse) {});

//-
// If the callback is omitted, we'll return a Promise.
//-
snapshot.getMetadata().then(function(data) {
  const metadata = data[0];
  const apiResponse = data[1];
});