Class protos.google.cloud.compute.v1.Instances (4.11.0)

Represents an Instances

Inheritance

$protobuf.rpc.Service > protos.google.cloud.compute.v1.Instances

Package

@google-cloud/compute

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Instances service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

addAccessConfig(request, callback)

public addAccessConfig(request: google.cloud.compute.v1.IAddAccessConfigInstanceRequest, callback: google.cloud.compute.v1.Instances.AddAccessConfigCallback): void;

Calls AddAccessConfig.

Parameters
Name Description
request IAddAccessConfigInstanceRequest

AddAccessConfigInstanceRequest message or plain object
callback AddAccessConfigCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

addAccessConfig(request)

public addAccessConfig(request: google.cloud.compute.v1.IAddAccessConfigInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AddAccessConfig.

Parameter
Name Description
request IAddAccessConfigInstanceRequest

AddAccessConfigInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

addResourcePolicies(request, callback)

public addResourcePolicies(request: google.cloud.compute.v1.IAddResourcePoliciesInstanceRequest, callback: google.cloud.compute.v1.Instances.AddResourcePoliciesCallback): void;

Calls AddResourcePolicies.

Parameters
Name Description
request IAddResourcePoliciesInstanceRequest

AddResourcePoliciesInstanceRequest message or plain object
callback AddResourcePoliciesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

addResourcePolicies(request)

public addResourcePolicies(request: google.cloud.compute.v1.IAddResourcePoliciesInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AddResourcePolicies.

Parameter
Name Description
request IAddResourcePoliciesInstanceRequest

AddResourcePoliciesInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

aggregatedList(request, callback)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListInstancesRequest, callback: google.cloud.compute.v1.Instances.AggregatedListCallback): void;

Calls AggregatedList.

Parameters
Name Description
request IAggregatedListInstancesRequest

AggregatedListInstancesRequest message or plain object
callback AggregatedListCallback

Node-style callback called with the error, if any, and InstanceAggregatedList
Returns
Type Description
void

aggregatedList(request)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListInstancesRequest): Promise<google.cloud.compute.v1.InstanceAggregatedList>;

Calls AggregatedList.

Parameter
Name Description
request IAggregatedListInstancesRequest

AggregatedListInstancesRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceAggregatedList>

Promise

attachDisk(request, callback)

public attachDisk(request: google.cloud.compute.v1.IAttachDiskInstanceRequest, callback: google.cloud.compute.v1.Instances.AttachDiskCallback): void;

Calls AttachDisk.

Parameters
Name Description
request IAttachDiskInstanceRequest

AttachDiskInstanceRequest message or plain object
callback AttachDiskCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

attachDisk(request)

public attachDisk(request: google.cloud.compute.v1.IAttachDiskInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AttachDisk.

Parameter
Name Description
request IAttachDiskInstanceRequest

AttachDiskInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

bulkInsert(request, callback)

public bulkInsert(request: google.cloud.compute.v1.IBulkInsertInstanceRequest, callback: google.cloud.compute.v1.Instances.BulkInsertCallback): void;

Calls BulkInsert.

Parameters
Name Description
request IBulkInsertInstanceRequest

BulkInsertInstanceRequest message or plain object
callback BulkInsertCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

bulkInsert(request)

public bulkInsert(request: google.cloud.compute.v1.IBulkInsertInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls BulkInsert.

Parameter
Name Description
request IBulkInsertInstanceRequest

BulkInsertInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Instances;

Creates new Instances service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Instances

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

delete(request, callback)

public delete(request: google.cloud.compute.v1.IDeleteInstanceRequest, callback: google.cloud.compute.v1.Instances.DeleteCallback): void;

Calls Delete.

Parameters
Name Description
request IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
callback DeleteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

delete(request)

public delete(request: google.cloud.compute.v1.IDeleteInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Delete.

Parameter
Name Description
request IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

deleteAccessConfig(request, callback)

public deleteAccessConfig(request: google.cloud.compute.v1.IDeleteAccessConfigInstanceRequest, callback: google.cloud.compute.v1.Instances.DeleteAccessConfigCallback): void;

Calls DeleteAccessConfig.

Parameters
Name Description
request IDeleteAccessConfigInstanceRequest

DeleteAccessConfigInstanceRequest message or plain object
callback DeleteAccessConfigCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteAccessConfig(request)

public deleteAccessConfig(request: google.cloud.compute.v1.IDeleteAccessConfigInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls DeleteAccessConfig.

Parameter
Name Description
request IDeleteAccessConfigInstanceRequest

DeleteAccessConfigInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

detachDisk(request, callback)

public detachDisk(request: google.cloud.compute.v1.IDetachDiskInstanceRequest, callback: google.cloud.compute.v1.Instances.DetachDiskCallback): void;

Calls DetachDisk.

Parameters
Name Description
request IDetachDiskInstanceRequest

DetachDiskInstanceRequest message or plain object
callback DetachDiskCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

detachDisk(request)

public detachDisk(request: google.cloud.compute.v1.IDetachDiskInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls DetachDisk.

Parameter
Name Description
request IDetachDiskInstanceRequest

DetachDiskInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

get(request, callback)

public get(request: google.cloud.compute.v1.IGetInstanceRequest, callback: google.cloud.compute.v1.Instances.GetCallback): void;

Calls Get.

Parameters
Name Description
request IGetInstanceRequest

GetInstanceRequest message or plain object
callback GetCallback

Node-style callback called with the error, if any, and Instance
Returns
Type Description
void

get(request)

public get(request: google.cloud.compute.v1.IGetInstanceRequest): Promise<google.cloud.compute.v1.Instance>;

Calls Get.

Parameter
Name Description
request IGetInstanceRequest

GetInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Instance>

Promise

getEffectiveFirewalls(request, callback)

public getEffectiveFirewalls(request: google.cloud.compute.v1.IGetEffectiveFirewallsInstanceRequest, callback: google.cloud.compute.v1.Instances.GetEffectiveFirewallsCallback): void;

Calls GetEffectiveFirewalls.

Parameters
Name Description
request IGetEffectiveFirewallsInstanceRequest

GetEffectiveFirewallsInstanceRequest message or plain object
callback GetEffectiveFirewallsCallback

Node-style callback called with the error, if any, and InstancesGetEffectiveFirewallsResponse
Returns
Type Description
void

getEffectiveFirewalls(request)

public getEffectiveFirewalls(request: google.cloud.compute.v1.IGetEffectiveFirewallsInstanceRequest): Promise<google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponse>;

Calls GetEffectiveFirewalls.

Parameter
Name Description
request IGetEffectiveFirewallsInstanceRequest

GetEffectiveFirewallsInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponse>

Promise

getGuestAttributes(request, callback)

public getGuestAttributes(request: google.cloud.compute.v1.IGetGuestAttributesInstanceRequest, callback: google.cloud.compute.v1.Instances.GetGuestAttributesCallback): void;

Calls GetGuestAttributes.

Parameters
Name Description
request IGetGuestAttributesInstanceRequest

GetGuestAttributesInstanceRequest message or plain object
callback GetGuestAttributesCallback

Node-style callback called with the error, if any, and GuestAttributes
Returns
Type Description
void

getGuestAttributes(request)

public getGuestAttributes(request: google.cloud.compute.v1.IGetGuestAttributesInstanceRequest): Promise<google.cloud.compute.v1.GuestAttributes>;

Calls GetGuestAttributes.

Parameter
Name Description
request IGetGuestAttributesInstanceRequest

GetGuestAttributesInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.GuestAttributes>

Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.cloud.compute.v1.IGetIamPolicyInstanceRequest, callback: google.cloud.compute.v1.Instances.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
Name Description
request IGetIamPolicyInstanceRequest

GetIamPolicyInstanceRequest message or plain object
callback GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns
Type Description
void

getIamPolicy(request)

public getIamPolicy(request: google.cloud.compute.v1.IGetIamPolicyInstanceRequest): Promise<google.cloud.compute.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name Description
request IGetIamPolicyInstanceRequest

GetIamPolicyInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Policy>

Promise

getScreenshot(request, callback)

public getScreenshot(request: google.cloud.compute.v1.IGetScreenshotInstanceRequest, callback: google.cloud.compute.v1.Instances.GetScreenshotCallback): void;

Calls GetScreenshot.

Parameters
Name Description
request IGetScreenshotInstanceRequest

GetScreenshotInstanceRequest message or plain object
callback GetScreenshotCallback

Node-style callback called with the error, if any, and Screenshot
Returns
Type Description
void

getScreenshot(request)

public getScreenshot(request: google.cloud.compute.v1.IGetScreenshotInstanceRequest): Promise<google.cloud.compute.v1.Screenshot>;

Calls GetScreenshot.

Parameter
Name Description
request IGetScreenshotInstanceRequest

GetScreenshotInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Screenshot>

Promise

getSerialPortOutput(request, callback)

public getSerialPortOutput(request: google.cloud.compute.v1.IGetSerialPortOutputInstanceRequest, callback: google.cloud.compute.v1.Instances.GetSerialPortOutputCallback): void;

Calls GetSerialPortOutput.

Parameters
Name Description
request IGetSerialPortOutputInstanceRequest

GetSerialPortOutputInstanceRequest message or plain object
callback GetSerialPortOutputCallback

Node-style callback called with the error, if any, and SerialPortOutput
Returns
Type Description
void

getSerialPortOutput(request)

public getSerialPortOutput(request: google.cloud.compute.v1.IGetSerialPortOutputInstanceRequest): Promise<google.cloud.compute.v1.SerialPortOutput>;

Calls GetSerialPortOutput.

Parameter
Name Description
request IGetSerialPortOutputInstanceRequest

GetSerialPortOutputInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.SerialPortOutput>

Promise

getShieldedInstanceIdentity(request, callback)

public getShieldedInstanceIdentity(request: google.cloud.compute.v1.IGetShieldedInstanceIdentityInstanceRequest, callback: google.cloud.compute.v1.Instances.GetShieldedInstanceIdentityCallback): void;

Calls GetShieldedInstanceIdentity.

Parameters
Name Description
request IGetShieldedInstanceIdentityInstanceRequest

GetShieldedInstanceIdentityInstanceRequest message or plain object
callback GetShieldedInstanceIdentityCallback

Node-style callback called with the error, if any, and ShieldedInstanceIdentity
Returns
Type Description
void

getShieldedInstanceIdentity(request)

public getShieldedInstanceIdentity(request: google.cloud.compute.v1.IGetShieldedInstanceIdentityInstanceRequest): Promise<google.cloud.compute.v1.ShieldedInstanceIdentity>;

Calls GetShieldedInstanceIdentity.

Parameter
Name Description
request IGetShieldedInstanceIdentityInstanceRequest

GetShieldedInstanceIdentityInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.ShieldedInstanceIdentity>

Promise

insert(request, callback)

public insert(request: google.cloud.compute.v1.IInsertInstanceRequest, callback: google.cloud.compute.v1.Instances.InsertCallback): void;

Calls Insert.

Parameters
Name Description
request IInsertInstanceRequest

InsertInstanceRequest message or plain object
callback InsertCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

insert(request)

public insert(request: google.cloud.compute.v1.IInsertInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Insert.

Parameter
Name Description
request IInsertInstanceRequest

InsertInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

list(request, callback)

public list(request: google.cloud.compute.v1.IListInstancesRequest, callback: google.cloud.compute.v1.Instances.ListCallback): void;

Calls List.

Parameters
Name Description
request IListInstancesRequest

ListInstancesRequest message or plain object
callback ListCallback

Node-style callback called with the error, if any, and InstanceList
Returns
Type Description
void

list(request)

public list(request: google.cloud.compute.v1.IListInstancesRequest): Promise<google.cloud.compute.v1.InstanceList>;

Calls List.

Parameter
Name Description
request IListInstancesRequest

ListInstancesRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceList>

Promise

listReferrers(request, callback)

public listReferrers(request: google.cloud.compute.v1.IListReferrersInstancesRequest, callback: google.cloud.compute.v1.Instances.ListReferrersCallback): void;

Calls ListReferrers.

Parameters
Name Description
request IListReferrersInstancesRequest

ListReferrersInstancesRequest message or plain object
callback ListReferrersCallback

Node-style callback called with the error, if any, and InstanceListReferrers
Returns
Type Description
void

listReferrers(request)

public listReferrers(request: google.cloud.compute.v1.IListReferrersInstancesRequest): Promise<google.cloud.compute.v1.InstanceListReferrers>;

Calls ListReferrers.

Parameter
Name Description
request IListReferrersInstancesRequest

ListReferrersInstancesRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceListReferrers>

Promise

performMaintenance(request, callback)

public performMaintenance(request: google.cloud.compute.v1.IPerformMaintenanceInstanceRequest, callback: google.cloud.compute.v1.Instances.PerformMaintenanceCallback): void;

Calls PerformMaintenance.

Parameters
Name Description
request IPerformMaintenanceInstanceRequest

PerformMaintenanceInstanceRequest message or plain object
callback PerformMaintenanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

performMaintenance(request)

public performMaintenance(request: google.cloud.compute.v1.IPerformMaintenanceInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls PerformMaintenance.

Parameter
Name Description
request IPerformMaintenanceInstanceRequest

PerformMaintenanceInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

removeResourcePolicies(request, callback)

public removeResourcePolicies(request: google.cloud.compute.v1.IRemoveResourcePoliciesInstanceRequest, callback: google.cloud.compute.v1.Instances.RemoveResourcePoliciesCallback): void;

Calls RemoveResourcePolicies.

Parameters
Name Description
request IRemoveResourcePoliciesInstanceRequest

RemoveResourcePoliciesInstanceRequest message or plain object
callback RemoveResourcePoliciesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

removeResourcePolicies(request)

public removeResourcePolicies(request: google.cloud.compute.v1.IRemoveResourcePoliciesInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls RemoveResourcePolicies.

Parameter
Name Description
request IRemoveResourcePoliciesInstanceRequest

RemoveResourcePoliciesInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

reset(request, callback)

public reset(request: google.cloud.compute.v1.IResetInstanceRequest, callback: google.cloud.compute.v1.Instances.ResetCallback): void;

Calls Reset.

Parameters
Name Description
request IResetInstanceRequest

ResetInstanceRequest message or plain object
callback ResetCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

reset(request)

public reset(request: google.cloud.compute.v1.IResetInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Reset.

Parameter
Name Description
request IResetInstanceRequest

ResetInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

resume(request, callback)

public resume(request: google.cloud.compute.v1.IResumeInstanceRequest, callback: google.cloud.compute.v1.Instances.ResumeCallback): void;

Calls Resume.

Parameters
Name Description
request IResumeInstanceRequest

ResumeInstanceRequest message or plain object
callback ResumeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

resume(request)

public resume(request: google.cloud.compute.v1.IResumeInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Resume.

Parameter
Name Description
request IResumeInstanceRequest

ResumeInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

sendDiagnosticInterrupt(request, callback)

public sendDiagnosticInterrupt(request: google.cloud.compute.v1.ISendDiagnosticInterruptInstanceRequest, callback: google.cloud.compute.v1.Instances.SendDiagnosticInterruptCallback): void;

Calls SendDiagnosticInterrupt.

Parameters
Name Description
request ISendDiagnosticInterruptInstanceRequest

SendDiagnosticInterruptInstanceRequest message or plain object
callback SendDiagnosticInterruptCallback

Node-style callback called with the error, if any, and SendDiagnosticInterruptInstanceResponse
Returns
Type Description
void

sendDiagnosticInterrupt(request)

public sendDiagnosticInterrupt(request: google.cloud.compute.v1.ISendDiagnosticInterruptInstanceRequest): Promise<google.cloud.compute.v1.SendDiagnosticInterruptInstanceResponse>;

Calls SendDiagnosticInterrupt.

Parameter
Name Description
request ISendDiagnosticInterruptInstanceRequest

SendDiagnosticInterruptInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.SendDiagnosticInterruptInstanceResponse>

Promise

setDeletionProtection(request, callback)

public setDeletionProtection(request: google.cloud.compute.v1.ISetDeletionProtectionInstanceRequest, callback: google.cloud.compute.v1.Instances.SetDeletionProtectionCallback): void;

Calls SetDeletionProtection.

Parameters
Name Description
request ISetDeletionProtectionInstanceRequest

SetDeletionProtectionInstanceRequest message or plain object
callback SetDeletionProtectionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setDeletionProtection(request)

public setDeletionProtection(request: google.cloud.compute.v1.ISetDeletionProtectionInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetDeletionProtection.

Parameter
Name Description
request ISetDeletionProtectionInstanceRequest

SetDeletionProtectionInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setDiskAutoDelete(request, callback)

public setDiskAutoDelete(request: google.cloud.compute.v1.ISetDiskAutoDeleteInstanceRequest, callback: google.cloud.compute.v1.Instances.SetDiskAutoDeleteCallback): void;

Calls SetDiskAutoDelete.

Parameters
Name Description
request ISetDiskAutoDeleteInstanceRequest

SetDiskAutoDeleteInstanceRequest message or plain object
callback SetDiskAutoDeleteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setDiskAutoDelete(request)

public setDiskAutoDelete(request: google.cloud.compute.v1.ISetDiskAutoDeleteInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetDiskAutoDelete.

Parameter
Name Description
request ISetDiskAutoDeleteInstanceRequest

SetDiskAutoDeleteInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.cloud.compute.v1.ISetIamPolicyInstanceRequest, callback: google.cloud.compute.v1.Instances.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
Name Description
request ISetIamPolicyInstanceRequest

SetIamPolicyInstanceRequest message or plain object
callback SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns
Type Description
void

setIamPolicy(request)

public setIamPolicy(request: google.cloud.compute.v1.ISetIamPolicyInstanceRequest): Promise<google.cloud.compute.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name Description
request ISetIamPolicyInstanceRequest

SetIamPolicyInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Policy>

Promise

setLabels(request, callback)

public setLabels(request: google.cloud.compute.v1.ISetLabelsInstanceRequest, callback: google.cloud.compute.v1.Instances.SetLabelsCallback): void;

Calls SetLabels.

Parameters
Name Description
request ISetLabelsInstanceRequest

SetLabelsInstanceRequest message or plain object
callback SetLabelsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setLabels(request)

public setLabels(request: google.cloud.compute.v1.ISetLabelsInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetLabels.

Parameter
Name Description
request ISetLabelsInstanceRequest

SetLabelsInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setMachineResources(request, callback)

public setMachineResources(request: google.cloud.compute.v1.ISetMachineResourcesInstanceRequest, callback: google.cloud.compute.v1.Instances.SetMachineResourcesCallback): void;

Calls SetMachineResources.

Parameters
Name Description
request ISetMachineResourcesInstanceRequest

SetMachineResourcesInstanceRequest message or plain object
callback SetMachineResourcesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setMachineResources(request)

public setMachineResources(request: google.cloud.compute.v1.ISetMachineResourcesInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetMachineResources.

Parameter
Name Description
request ISetMachineResourcesInstanceRequest

SetMachineResourcesInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setMachineType(request, callback)

public setMachineType(request: google.cloud.compute.v1.ISetMachineTypeInstanceRequest, callback: google.cloud.compute.v1.Instances.SetMachineTypeCallback): void;

Calls SetMachineType.

Parameters
Name Description
request ISetMachineTypeInstanceRequest

SetMachineTypeInstanceRequest message or plain object
callback SetMachineTypeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setMachineType(request)

public setMachineType(request: google.cloud.compute.v1.ISetMachineTypeInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetMachineType.

Parameter
Name Description
request ISetMachineTypeInstanceRequest

SetMachineTypeInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setMetadata(request, callback)

public setMetadata(request: google.cloud.compute.v1.ISetMetadataInstanceRequest, callback: google.cloud.compute.v1.Instances.SetMetadataCallback): void;

Calls SetMetadata.

Parameters
Name Description
request ISetMetadataInstanceRequest

SetMetadataInstanceRequest message or plain object
callback SetMetadataCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setMetadata(request)

public setMetadata(request: google.cloud.compute.v1.ISetMetadataInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetMetadata.

Parameter
Name Description
request ISetMetadataInstanceRequest

SetMetadataInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setMinCpuPlatform(request, callback)

public setMinCpuPlatform(request: google.cloud.compute.v1.ISetMinCpuPlatformInstanceRequest, callback: google.cloud.compute.v1.Instances.SetMinCpuPlatformCallback): void;

Calls SetMinCpuPlatform.

Parameters
Name Description
request ISetMinCpuPlatformInstanceRequest

SetMinCpuPlatformInstanceRequest message or plain object
callback SetMinCpuPlatformCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setMinCpuPlatform(request)

public setMinCpuPlatform(request: google.cloud.compute.v1.ISetMinCpuPlatformInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetMinCpuPlatform.

Parameter
Name Description
request ISetMinCpuPlatformInstanceRequest

SetMinCpuPlatformInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setName(request, callback)

public setName(request: google.cloud.compute.v1.ISetNameInstanceRequest, callback: google.cloud.compute.v1.Instances.SetNameCallback): void;

Calls SetName.

Parameters
Name Description
request ISetNameInstanceRequest

SetNameInstanceRequest message or plain object
callback SetNameCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setName(request)

public setName(request: google.cloud.compute.v1.ISetNameInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetName.

Parameter
Name Description
request ISetNameInstanceRequest

SetNameInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setScheduling(request, callback)

public setScheduling(request: google.cloud.compute.v1.ISetSchedulingInstanceRequest, callback: google.cloud.compute.v1.Instances.SetSchedulingCallback): void;

Calls SetScheduling.

Parameters
Name Description
request ISetSchedulingInstanceRequest

SetSchedulingInstanceRequest message or plain object
callback SetSchedulingCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setScheduling(request)

public setScheduling(request: google.cloud.compute.v1.ISetSchedulingInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetScheduling.

Parameter
Name Description
request ISetSchedulingInstanceRequest

SetSchedulingInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setSecurityPolicy(request, callback)

public setSecurityPolicy(request: google.cloud.compute.v1.ISetSecurityPolicyInstanceRequest, callback: google.cloud.compute.v1.Instances.SetSecurityPolicyCallback): void;

Calls SetSecurityPolicy.

Parameters
Name Description
request ISetSecurityPolicyInstanceRequest

SetSecurityPolicyInstanceRequest message or plain object
callback SetSecurityPolicyCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setSecurityPolicy(request)

public setSecurityPolicy(request: google.cloud.compute.v1.ISetSecurityPolicyInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetSecurityPolicy.

Parameter
Name Description
request ISetSecurityPolicyInstanceRequest

SetSecurityPolicyInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setServiceAccount(request, callback)

public setServiceAccount(request: google.cloud.compute.v1.ISetServiceAccountInstanceRequest, callback: google.cloud.compute.v1.Instances.SetServiceAccountCallback): void;

Calls SetServiceAccount.

Parameters
Name Description
request ISetServiceAccountInstanceRequest

SetServiceAccountInstanceRequest message or plain object
callback SetServiceAccountCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setServiceAccount(request)

public setServiceAccount(request: google.cloud.compute.v1.ISetServiceAccountInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetServiceAccount.

Parameter
Name Description
request ISetServiceAccountInstanceRequest

SetServiceAccountInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setShieldedInstanceIntegrityPolicy(request, callback)

public setShieldedInstanceIntegrityPolicy(request: google.cloud.compute.v1.ISetShieldedInstanceIntegrityPolicyInstanceRequest, callback: google.cloud.compute.v1.Instances.SetShieldedInstanceIntegrityPolicyCallback): void;

Calls SetShieldedInstanceIntegrityPolicy.

Parameters
Name Description
request ISetShieldedInstanceIntegrityPolicyInstanceRequest

SetShieldedInstanceIntegrityPolicyInstanceRequest message or plain object
callback SetShieldedInstanceIntegrityPolicyCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setShieldedInstanceIntegrityPolicy(request)

public setShieldedInstanceIntegrityPolicy(request: google.cloud.compute.v1.ISetShieldedInstanceIntegrityPolicyInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetShieldedInstanceIntegrityPolicy.

Parameter
Name Description
request ISetShieldedInstanceIntegrityPolicyInstanceRequest

SetShieldedInstanceIntegrityPolicyInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setTags(request, callback)

public setTags(request: google.cloud.compute.v1.ISetTagsInstanceRequest, callback: google.cloud.compute.v1.Instances.SetTagsCallback): void;

Calls SetTags.

Parameters
Name Description
request ISetTagsInstanceRequest

SetTagsInstanceRequest message or plain object
callback SetTagsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setTags(request)

public setTags(request: google.cloud.compute.v1.ISetTagsInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetTags.

Parameter
Name Description
request ISetTagsInstanceRequest

SetTagsInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

simulateMaintenanceEvent(request, callback)

public simulateMaintenanceEvent(request: google.cloud.compute.v1.ISimulateMaintenanceEventInstanceRequest, callback: google.cloud.compute.v1.Instances.SimulateMaintenanceEventCallback): void;

Calls SimulateMaintenanceEvent.

Parameters
Name Description
request ISimulateMaintenanceEventInstanceRequest

SimulateMaintenanceEventInstanceRequest message or plain object
callback SimulateMaintenanceEventCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

simulateMaintenanceEvent(request)

public simulateMaintenanceEvent(request: google.cloud.compute.v1.ISimulateMaintenanceEventInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SimulateMaintenanceEvent.

Parameter
Name Description
request ISimulateMaintenanceEventInstanceRequest

SimulateMaintenanceEventInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

start(request, callback)

public start(request: google.cloud.compute.v1.IStartInstanceRequest, callback: google.cloud.compute.v1.Instances.StartCallback): void;

Calls Start.

Parameters
Name Description
request IStartInstanceRequest

StartInstanceRequest message or plain object
callback StartCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

start(request)

public start(request: google.cloud.compute.v1.IStartInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Start.

Parameter
Name Description
request IStartInstanceRequest

StartInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

startWithEncryptionKey(request, callback)

public startWithEncryptionKey(request: google.cloud.compute.v1.IStartWithEncryptionKeyInstanceRequest, callback: google.cloud.compute.v1.Instances.StartWithEncryptionKeyCallback): void;

Calls StartWithEncryptionKey.

Parameters
Name Description
request IStartWithEncryptionKeyInstanceRequest

StartWithEncryptionKeyInstanceRequest message or plain object
callback StartWithEncryptionKeyCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

startWithEncryptionKey(request)

public startWithEncryptionKey(request: google.cloud.compute.v1.IStartWithEncryptionKeyInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls StartWithEncryptionKey.

Parameter
Name Description
request IStartWithEncryptionKeyInstanceRequest

StartWithEncryptionKeyInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

stop(request, callback)

public stop(request: google.cloud.compute.v1.IStopInstanceRequest, callback: google.cloud.compute.v1.Instances.StopCallback): void;

Calls Stop.

Parameters
Name Description
request IStopInstanceRequest

StopInstanceRequest message or plain object
callback StopCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

stop(request)

public stop(request: google.cloud.compute.v1.IStopInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Stop.

Parameter
Name Description
request IStopInstanceRequest

StopInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

suspend(request, callback)

public suspend(request: google.cloud.compute.v1.ISuspendInstanceRequest, callback: google.cloud.compute.v1.Instances.SuspendCallback): void;

Calls Suspend.

Parameters
Name Description
request ISuspendInstanceRequest

SuspendInstanceRequest message or plain object
callback SuspendCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

suspend(request)

public suspend(request: google.cloud.compute.v1.ISuspendInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Suspend.

Parameter
Name Description
request ISuspendInstanceRequest

SuspendInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.cloud.compute.v1.ITestIamPermissionsInstanceRequest, callback: google.cloud.compute.v1.Instances.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Name Description
request ITestIamPermissionsInstanceRequest

TestIamPermissionsInstanceRequest message or plain object
callback TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestPermissionsResponse
Returns
Type Description
void

testIamPermissions(request)

public testIamPermissions(request: google.cloud.compute.v1.ITestIamPermissionsInstanceRequest): Promise<google.cloud.compute.v1.TestPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name Description
request ITestIamPermissionsInstanceRequest

TestIamPermissionsInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.TestPermissionsResponse>

Promise

update(request, callback)

public update(request: google.cloud.compute.v1.IUpdateInstanceRequest, callback: google.cloud.compute.v1.Instances.UpdateCallback): void;

Calls Update.

Parameters
Name Description
request IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
callback UpdateCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

update(request)

public update(request: google.cloud.compute.v1.IUpdateInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Update.

Parameter
Name Description
request IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

updateAccessConfig(request, callback)

public updateAccessConfig(request: google.cloud.compute.v1.IUpdateAccessConfigInstanceRequest, callback: google.cloud.compute.v1.Instances.UpdateAccessConfigCallback): void;

Calls UpdateAccessConfig.

Parameters
Name Description
request IUpdateAccessConfigInstanceRequest

UpdateAccessConfigInstanceRequest message or plain object
callback UpdateAccessConfigCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateAccessConfig(request)

public updateAccessConfig(request: google.cloud.compute.v1.IUpdateAccessConfigInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls UpdateAccessConfig.

Parameter
Name Description
request IUpdateAccessConfigInstanceRequest

UpdateAccessConfigInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

updateDisplayDevice(request, callback)

public updateDisplayDevice(request: google.cloud.compute.v1.IUpdateDisplayDeviceInstanceRequest, callback: google.cloud.compute.v1.Instances.UpdateDisplayDeviceCallback): void;

Calls UpdateDisplayDevice.

Parameters
Name Description
request IUpdateDisplayDeviceInstanceRequest

UpdateDisplayDeviceInstanceRequest message or plain object
callback UpdateDisplayDeviceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateDisplayDevice(request)

public updateDisplayDevice(request: google.cloud.compute.v1.IUpdateDisplayDeviceInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls UpdateDisplayDevice.

Parameter
Name Description
request IUpdateDisplayDeviceInstanceRequest

UpdateDisplayDeviceInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

updateNetworkInterface(request, callback)

public updateNetworkInterface(request: google.cloud.compute.v1.IUpdateNetworkInterfaceInstanceRequest, callback: google.cloud.compute.v1.Instances.UpdateNetworkInterfaceCallback): void;

Calls UpdateNetworkInterface.

Parameters
Name Description
request IUpdateNetworkInterfaceInstanceRequest

UpdateNetworkInterfaceInstanceRequest message or plain object
callback UpdateNetworkInterfaceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateNetworkInterface(request)

public updateNetworkInterface(request: google.cloud.compute.v1.IUpdateNetworkInterfaceInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls UpdateNetworkInterface.

Parameter
Name Description
request IUpdateNetworkInterfaceInstanceRequest

UpdateNetworkInterfaceInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

updateShieldedInstanceConfig(request, callback)

public updateShieldedInstanceConfig(request: google.cloud.compute.v1.IUpdateShieldedInstanceConfigInstanceRequest, callback: google.cloud.compute.v1.Instances.UpdateShieldedInstanceConfigCallback): void;

Calls UpdateShieldedInstanceConfig.

Parameters
Name Description
request IUpdateShieldedInstanceConfigInstanceRequest

UpdateShieldedInstanceConfigInstanceRequest message or plain object
callback UpdateShieldedInstanceConfigCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateShieldedInstanceConfig(request)

public updateShieldedInstanceConfig(request: google.cloud.compute.v1.IUpdateShieldedInstanceConfigInstanceRequest): Promise<google.cloud.compute.v1.Operation>;

Calls UpdateShieldedInstanceConfig.

Parameter
Name Description
request IUpdateShieldedInstanceConfigInstanceRequest

UpdateShieldedInstanceConfigInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise