Snapshots

google.cloud.compute.v1. Snapshots

Represents a Snapshots

Constructor

new Snapshots(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Snapshots service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

delete(request, callback) → {undefined}

Calls Delete.

Parameters:
Name Type Description
request google.cloud.compute.v1.IDeleteSnapshotRequest

DeleteSnapshotRequest message or plain object

callback google.cloud.compute.v1.Snapshots.DeleteCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

delete(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Delete.

Parameters:
Name Type Description
request google.cloud.compute.v1.IDeleteSnapshotRequest

DeleteSnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

get(request, callback) → {undefined}

Calls Get.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetSnapshotRequest

GetSnapshotRequest message or plain object

callback google.cloud.compute.v1.Snapshots.GetCallback

Node-style callback called with the error, if any, and Snapshot

Returns:
Type Description
undefined

get(request) → {Promise.<google.cloud.compute.v1.Snapshot>}

Calls Get.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetSnapshotRequest

GetSnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Snapshot>

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetIamPolicySnapshotRequest

GetIamPolicySnapshotRequest message or plain object

callback google.cloud.compute.v1.Snapshots.GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

getIamPolicy(request) → {Promise.<google.cloud.compute.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetIamPolicySnapshotRequest

GetIamPolicySnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Policy>

Promise

insert(request, callback) → {undefined}

Calls Insert.

Parameters:
Name Type Description
request google.cloud.compute.v1.IInsertSnapshotRequest

InsertSnapshotRequest message or plain object

callback google.cloud.compute.v1.Snapshots.InsertCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

insert(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Insert.

Parameters:
Name Type Description
request google.cloud.compute.v1.IInsertSnapshotRequest

InsertSnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

list(request, callback) → {undefined}

Calls List.

Parameters:
Name Type Description
request google.cloud.compute.v1.IListSnapshotsRequest

ListSnapshotsRequest message or plain object

callback google.cloud.compute.v1.Snapshots.ListCallback

Node-style callback called with the error, if any, and SnapshotList

Returns:
Type Description
undefined

list(request) → {Promise.<google.cloud.compute.v1.SnapshotList>}

Calls List.

Parameters:
Name Type Description
request google.cloud.compute.v1.IListSnapshotsRequest

ListSnapshotsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.SnapshotList>

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.cloud.compute.v1.ISetIamPolicySnapshotRequest

SetIamPolicySnapshotRequest message or plain object

callback google.cloud.compute.v1.Snapshots.SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

setIamPolicy(request) → {Promise.<google.cloud.compute.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.cloud.compute.v1.ISetIamPolicySnapshotRequest

SetIamPolicySnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Policy>

Promise

setLabels(request, callback) → {undefined}

Calls SetLabels.

Parameters:
Name Type Description
request google.cloud.compute.v1.ISetLabelsSnapshotRequest

SetLabelsSnapshotRequest message or plain object

callback google.cloud.compute.v1.Snapshots.SetLabelsCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

setLabels(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls SetLabels.

Parameters:
Name Type Description
request google.cloud.compute.v1.ISetLabelsSnapshotRequest

SetLabelsSnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest

TestIamPermissionsSnapshotRequest message or plain object

callback google.cloud.compute.v1.Snapshots.TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestPermissionsResponse

Returns:
Type Description
undefined

testIamPermissions(request) → {Promise.<google.cloud.compute.v1.TestPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.cloud.compute.v1.ITestIamPermissionsSnapshotRequest

TestIamPermissionsSnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.TestPermissionsResponse>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Snapshots}

Creates new Snapshots service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
Snapshots

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

DeleteCallback(error, responseopt)

Callback as used by delete_.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

GetCallback(error, responseopt)

Callback as used by get.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Snapshot <optional>

Snapshot

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Policy <optional>

Policy

InsertCallback(error, responseopt)

Callback as used by insert.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

ListCallback(error, responseopt)

Callback as used by list.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.SnapshotList <optional>

SnapshotList

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Policy <optional>

Policy

SetLabelsCallback(error, responseopt)

Callback as used by setLabels.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.TestPermissionsResponse <optional>

TestPermissionsResponse