Instances

google.cloud.compute.v1. Instances

Represents an Instances

Constructor

new Instances(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Instances 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

addAccessConfig(request, callback) → {undefined}

Calls AddAccessConfig.

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

AddAccessConfigInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.AddAccessConfigCallback

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

Returns:
Type Description
undefined

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

Calls AddAccessConfig.

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

AddAccessConfigInstanceRequest message or plain object

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

Promise

addResourcePolicies(request, callback) → {undefined}

Calls AddResourcePolicies.

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

AddResourcePoliciesInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.AddResourcePoliciesCallback

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

Returns:
Type Description
undefined

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

Calls AddResourcePolicies.

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

AddResourcePoliciesInstanceRequest message or plain object

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

Promise

aggregatedList(request, callback) → {undefined}

Calls AggregatedList.

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

AggregatedListInstancesRequest message or plain object

callback google.cloud.compute.v1.Instances.AggregatedListCallback

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

Returns:
Type Description
undefined

aggregatedList(request) → {Promise.<google.cloud.compute.v1.InstanceAggregatedList>}

Calls AggregatedList.

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

AggregatedListInstancesRequest message or plain object

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

Promise

attachDisk(request, callback) → {undefined}

Calls AttachDisk.

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

AttachDiskInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.AttachDiskCallback

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

Returns:
Type Description
undefined

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

Calls AttachDisk.

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

AttachDiskInstanceRequest message or plain object

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

Promise

bulkInsert(request, callback) → {undefined}

Calls BulkInsert.

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

BulkInsertInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.BulkInsertCallback

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

Returns:
Type Description
undefined

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

Calls BulkInsert.

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

BulkInsertInstanceRequest message or plain object

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

Promise

delete(request, callback) → {undefined}

Calls Delete.

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

DeleteInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.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.IDeleteInstanceRequest

DeleteInstanceRequest message or plain object

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

Promise

deleteAccessConfig(request, callback) → {undefined}

Calls DeleteAccessConfig.

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

DeleteAccessConfigInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.DeleteAccessConfigCallback

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

Returns:
Type Description
undefined

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

Calls DeleteAccessConfig.

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

DeleteAccessConfigInstanceRequest message or plain object

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

Promise

detachDisk(request, callback) → {undefined}

Calls DetachDisk.

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

DetachDiskInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.DetachDiskCallback

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

Returns:
Type Description
undefined

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

Calls DetachDisk.

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

DetachDiskInstanceRequest 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.IGetInstanceRequest

GetInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.GetCallback

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

Returns:
Type Description
undefined

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

Calls Get.

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

GetInstanceRequest message or plain object

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

Promise

getEffectiveFirewalls(request, callback) → {undefined}

Calls GetEffectiveFirewalls.

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

GetEffectiveFirewallsInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.GetEffectiveFirewallsCallback

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

Returns:
Type Description
undefined

getEffectiveFirewalls(request) → {Promise.<google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponse>}

Calls GetEffectiveFirewalls.

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

GetEffectiveFirewallsInstanceRequest message or plain object

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

Promise

getGuestAttributes(request, callback) → {undefined}

Calls GetGuestAttributes.

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

GetGuestAttributesInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.GetGuestAttributesCallback

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

Returns:
Type Description
undefined

getGuestAttributes(request) → {Promise.<google.cloud.compute.v1.GuestAttributes>}

Calls GetGuestAttributes.

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

GetGuestAttributesInstanceRequest message or plain object

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

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

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

GetIamPolicyInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.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.IGetIamPolicyInstanceRequest

GetIamPolicyInstanceRequest message or plain object

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

Promise

getScreenshot(request, callback) → {undefined}

Calls GetScreenshot.

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

GetScreenshotInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.GetScreenshotCallback

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

Returns:
Type Description
undefined

getScreenshot(request) → {Promise.<google.cloud.compute.v1.Screenshot>}

Calls GetScreenshot.

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

GetScreenshotInstanceRequest message or plain object

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

Promise

getSerialPortOutput(request, callback) → {undefined}

Calls GetSerialPortOutput.

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

GetSerialPortOutputInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.GetSerialPortOutputCallback

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

Returns:
Type Description
undefined

getSerialPortOutput(request) → {Promise.<google.cloud.compute.v1.SerialPortOutput>}

Calls GetSerialPortOutput.

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

GetSerialPortOutputInstanceRequest message or plain object

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

Promise

getShieldedInstanceIdentity(request, callback) → {undefined}

Calls GetShieldedInstanceIdentity.

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

GetShieldedInstanceIdentityInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.GetShieldedInstanceIdentityCallback

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

Returns:
Type Description
undefined

getShieldedInstanceIdentity(request) → {Promise.<google.cloud.compute.v1.ShieldedInstanceIdentity>}

Calls GetShieldedInstanceIdentity.

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

GetShieldedInstanceIdentityInstanceRequest message or plain object

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

Promise

insert(request, callback) → {undefined}

Calls Insert.

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

InsertInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.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.IInsertInstanceRequest

InsertInstanceRequest 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.IListInstancesRequest

ListInstancesRequest message or plain object

callback google.cloud.compute.v1.Instances.ListCallback

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

Returns:
Type Description
undefined

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

Calls List.

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

ListInstancesRequest message or plain object

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

Promise

listReferrers(request, callback) → {undefined}

Calls ListReferrers.

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

ListReferrersInstancesRequest message or plain object

callback google.cloud.compute.v1.Instances.ListReferrersCallback

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

Returns:
Type Description
undefined

listReferrers(request) → {Promise.<google.cloud.compute.v1.InstanceListReferrers>}

Calls ListReferrers.

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

ListReferrersInstancesRequest message or plain object

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

Promise

removeResourcePolicies(request, callback) → {undefined}

Calls RemoveResourcePolicies.

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

RemoveResourcePoliciesInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.RemoveResourcePoliciesCallback

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

Returns:
Type Description
undefined

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

Calls RemoveResourcePolicies.

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

RemoveResourcePoliciesInstanceRequest message or plain object

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

Promise

reset(request, callback) → {undefined}

Calls Reset.

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

ResetInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.ResetCallback

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

Returns:
Type Description
undefined

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

Calls Reset.

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

ResetInstanceRequest message or plain object

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

Promise

resume(request, callback) → {undefined}

Calls Resume.

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

ResumeInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.ResumeCallback

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

Returns:
Type Description
undefined

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

Calls Resume.

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

ResumeInstanceRequest message or plain object

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

Promise

sendDiagnosticInterrupt(request, callback) → {undefined}

Calls SendDiagnosticInterrupt.

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

SendDiagnosticInterruptInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SendDiagnosticInterruptCallback

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

Returns:
Type Description
undefined

sendDiagnosticInterrupt(request) → {Promise.<google.cloud.compute.v1.SendDiagnosticInterruptInstanceResponse>}

Calls SendDiagnosticInterrupt.

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

SendDiagnosticInterruptInstanceRequest message or plain object

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

Promise

setDeletionProtection(request, callback) → {undefined}

Calls SetDeletionProtection.

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

SetDeletionProtectionInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetDeletionProtectionCallback

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

Returns:
Type Description
undefined

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

Calls SetDeletionProtection.

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

SetDeletionProtectionInstanceRequest message or plain object

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

Promise

setDiskAutoDelete(request, callback) → {undefined}

Calls SetDiskAutoDelete.

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

SetDiskAutoDeleteInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetDiskAutoDeleteCallback

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

Returns:
Type Description
undefined

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

Calls SetDiskAutoDelete.

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

SetDiskAutoDeleteInstanceRequest message or plain object

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

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

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

SetIamPolicyInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.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.ISetIamPolicyInstanceRequest

SetIamPolicyInstanceRequest 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.ISetLabelsInstanceRequest

SetLabelsInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.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.ISetLabelsInstanceRequest

SetLabelsInstanceRequest message or plain object

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

Promise

setMachineResources(request, callback) → {undefined}

Calls SetMachineResources.

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

SetMachineResourcesInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetMachineResourcesCallback

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

Returns:
Type Description
undefined

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

Calls SetMachineResources.

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

SetMachineResourcesInstanceRequest message or plain object

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

Promise

setMachineType(request, callback) → {undefined}

Calls SetMachineType.

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

SetMachineTypeInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetMachineTypeCallback

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

Returns:
Type Description
undefined

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

Calls SetMachineType.

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

SetMachineTypeInstanceRequest message or plain object

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

Promise

setMetadata(request, callback) → {undefined}

Calls SetMetadata.

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

SetMetadataInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetMetadataCallback

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

Returns:
Type Description
undefined

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

Calls SetMetadata.

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

SetMetadataInstanceRequest message or plain object

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

Promise

setMinCpuPlatform(request, callback) → {undefined}

Calls SetMinCpuPlatform.

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

SetMinCpuPlatformInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetMinCpuPlatformCallback

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

Returns:
Type Description
undefined

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

Calls SetMinCpuPlatform.

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

SetMinCpuPlatformInstanceRequest message or plain object

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

Promise

setName(request, callback) → {undefined}

Calls SetName.

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

SetNameInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetNameCallback

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

Returns:
Type Description
undefined

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

Calls SetName.

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

SetNameInstanceRequest message or plain object

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

Promise

setScheduling(request, callback) → {undefined}

Calls SetScheduling.

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

SetSchedulingInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetSchedulingCallback

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

Returns:
Type Description
undefined

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

Calls SetScheduling.

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

SetSchedulingInstanceRequest message or plain object

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

Promise

setServiceAccount(request, callback) → {undefined}

Calls SetServiceAccount.

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

SetServiceAccountInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetServiceAccountCallback

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

Returns:
Type Description
undefined

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

Calls SetServiceAccount.

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

SetServiceAccountInstanceRequest message or plain object

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

Promise

setShieldedInstanceIntegrityPolicy(request, callback) → {undefined}

Calls SetShieldedInstanceIntegrityPolicy.

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

SetShieldedInstanceIntegrityPolicyInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetShieldedInstanceIntegrityPolicyCallback

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

Returns:
Type Description
undefined

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

Calls SetShieldedInstanceIntegrityPolicy.

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

SetShieldedInstanceIntegrityPolicyInstanceRequest message or plain object

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

Promise

setTags(request, callback) → {undefined}

Calls SetTags.

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

SetTagsInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SetTagsCallback

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

Returns:
Type Description
undefined

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

Calls SetTags.

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

SetTagsInstanceRequest message or plain object

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

Promise

simulateMaintenanceEvent(request, callback) → {undefined}

Calls SimulateMaintenanceEvent.

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

SimulateMaintenanceEventInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SimulateMaintenanceEventCallback

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

Returns:
Type Description
undefined

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

Calls SimulateMaintenanceEvent.

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

SimulateMaintenanceEventInstanceRequest message or plain object

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

Promise

start(request, callback) → {undefined}

Calls Start.

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

StartInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.StartCallback

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

Returns:
Type Description
undefined

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

Calls Start.

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

StartInstanceRequest message or plain object

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

Promise

startWithEncryptionKey(request, callback) → {undefined}

Calls StartWithEncryptionKey.

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

StartWithEncryptionKeyInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.StartWithEncryptionKeyCallback

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

Returns:
Type Description
undefined

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

Calls StartWithEncryptionKey.

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

StartWithEncryptionKeyInstanceRequest message or plain object

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

Promise

stop(request, callback) → {undefined}

Calls Stop.

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

StopInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.StopCallback

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

Returns:
Type Description
undefined

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

Calls Stop.

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

StopInstanceRequest message or plain object

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

Promise

suspend(request, callback) → {undefined}

Calls Suspend.

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

SuspendInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.SuspendCallback

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

Returns:
Type Description
undefined

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

Calls Suspend.

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

SuspendInstanceRequest 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.ITestIamPermissionsInstanceRequest

TestIamPermissionsInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.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.ITestIamPermissionsInstanceRequest

TestIamPermissionsInstanceRequest message or plain object

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

Promise

update(request, callback) → {undefined}

Calls Update.

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

UpdateInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.UpdateCallback

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

Returns:
Type Description
undefined

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

Calls Update.

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

UpdateInstanceRequest message or plain object

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

Promise

updateAccessConfig(request, callback) → {undefined}

Calls UpdateAccessConfig.

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

UpdateAccessConfigInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.UpdateAccessConfigCallback

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

Returns:
Type Description
undefined

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

Calls UpdateAccessConfig.

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

UpdateAccessConfigInstanceRequest message or plain object

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

Promise

updateDisplayDevice(request, callback) → {undefined}

Calls UpdateDisplayDevice.

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

UpdateDisplayDeviceInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.UpdateDisplayDeviceCallback

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

Returns:
Type Description
undefined

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

Calls UpdateDisplayDevice.

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

UpdateDisplayDeviceInstanceRequest message or plain object

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

Promise

updateNetworkInterface(request, callback) → {undefined}

Calls UpdateNetworkInterface.

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

UpdateNetworkInterfaceInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.UpdateNetworkInterfaceCallback

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

Returns:
Type Description
undefined

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

Calls UpdateNetworkInterface.

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

UpdateNetworkInterfaceInstanceRequest message or plain object

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

Promise

updateShieldedInstanceConfig(request, callback) → {undefined}

Calls UpdateShieldedInstanceConfig.

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

UpdateShieldedInstanceConfigInstanceRequest message or plain object

callback google.cloud.compute.v1.Instances.UpdateShieldedInstanceConfigCallback

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

Returns:
Type Description
undefined

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

Calls UpdateShieldedInstanceConfig.

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

UpdateShieldedInstanceConfigInstanceRequest message or plain object

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

Promise

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

Creates new Instances 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
Instances

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

Type Definitions

AddAccessConfigCallback(error, responseopt)

Callback as used by addAccessConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

AddResourcePoliciesCallback(error, responseopt)

Callback as used by addResourcePolicies.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

AggregatedListCallback(error, responseopt)

Callback as used by aggregatedList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

InstanceAggregatedList

AttachDiskCallback(error, responseopt)

Callback as used by attachDisk.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

BulkInsertCallback(error, responseopt)

Callback as used by bulkInsert.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

DeleteAccessConfigCallback(error, responseopt)

Callback as used by deleteAccessConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

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

DetachDiskCallback(error, responseopt)

Callback as used by detachDisk.

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.Instance <optional>

Instance

GetEffectiveFirewallsCallback(error, responseopt)

Callback as used by getEffectiveFirewalls.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

InstancesGetEffectiveFirewallsResponse

GetGuestAttributesCallback(error, responseopt)

Callback as used by getGuestAttributes.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

GuestAttributes

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

GetScreenshotCallback(error, responseopt)

Callback as used by getScreenshot.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Screenshot

GetSerialPortOutputCallback(error, responseopt)

Callback as used by getSerialPortOutput.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

SerialPortOutput

GetShieldedInstanceIdentityCallback(error, responseopt)

Callback as used by getShieldedInstanceIdentity.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

ShieldedInstanceIdentity

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.InstanceList <optional>

InstanceList

ListReferrersCallback(error, responseopt)

Callback as used by listReferrers.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

InstanceListReferrers

RemoveResourcePoliciesCallback(error, responseopt)

Callback as used by removeResourcePolicies.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

ResetCallback(error, responseopt)

Callback as used by reset.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

ResumeCallback(error, responseopt)

Callback as used by resume.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SendDiagnosticInterruptCallback(error, responseopt)

Callback as used by sendDiagnosticInterrupt.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

SendDiagnosticInterruptInstanceResponse

SetDeletionProtectionCallback(error, responseopt)

Callback as used by setDeletionProtection.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetDiskAutoDeleteCallback(error, responseopt)

Callback as used by setDiskAutoDelete.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

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

SetMachineResourcesCallback(error, responseopt)

Callback as used by setMachineResources.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetMachineTypeCallback(error, responseopt)

Callback as used by setMachineType.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetMetadataCallback(error, responseopt)

Callback as used by setMetadata.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetMinCpuPlatformCallback(error, responseopt)

Callback as used by setMinCpuPlatform.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetNameCallback(error, responseopt)

Callback as used by setName.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetSchedulingCallback(error, responseopt)

Callback as used by setScheduling.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetServiceAccountCallback(error, responseopt)

Callback as used by setServiceAccount.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetShieldedInstanceIntegrityPolicyCallback(error, responseopt)

Callback as used by setShieldedInstanceIntegrityPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SetTagsCallback(error, responseopt)

Callback as used by setTags.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SimulateMaintenanceEventCallback(error, responseopt)

Callback as used by simulateMaintenanceEvent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

StartCallback(error, responseopt)

Callback as used by start.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

StartWithEncryptionKeyCallback(error, responseopt)

Callback as used by startWithEncryptionKey.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

StopCallback(error, responseopt)

Callback as used by stop.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

SuspendCallback(error, responseopt)

Callback as used by suspend.

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

UpdateAccessConfigCallback(error, responseopt)

Callback as used by updateAccessConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

UpdateCallback(error, responseopt)

Callback as used by update.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

UpdateDisplayDeviceCallback(error, responseopt)

Callback as used by updateDisplayDevice.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

UpdateNetworkInterfaceCallback(error, responseopt)

Callback as used by updateNetworkInterface.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation

UpdateShieldedInstanceConfigCallback(error, responseopt)

Callback as used by updateShieldedInstanceConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

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

Operation