Class protos.google.cloud.compute.v1.Disks (4.5.0)

Represents a Disks

Inheritance

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

Package

@google-cloud/compute

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Disks service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

addResourcePolicies(request, callback)

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

Calls AddResourcePolicies.

Parameters
Name Description
request IAddResourcePoliciesDiskRequest

AddResourcePoliciesDiskRequest 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.IAddResourcePoliciesDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AddResourcePolicies.

Parameter
Name Description
request IAddResourcePoliciesDiskRequest

AddResourcePoliciesDiskRequest message or plain object

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

Promise

aggregatedList(request, callback)

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

Calls AggregatedList.

Parameters
Name Description
request IAggregatedListDisksRequest

AggregatedListDisksRequest message or plain object

callback AggregatedListCallback

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

Returns
Type Description
void

aggregatedList(request)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListDisksRequest): Promise<google.cloud.compute.v1.DiskAggregatedList>;

Calls AggregatedList.

Parameter
Name Description
request IAggregatedListDisksRequest

AggregatedListDisksRequest message or plain object

Returns
Type Description
Promise<google.cloud.compute.v1.DiskAggregatedList>

Promise

bulkInsert(request, callback)

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

Calls BulkInsert.

Parameters
Name Description
request IBulkInsertDiskRequest

BulkInsertDiskRequest 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.IBulkInsertDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls BulkInsert.

Parameter
Name Description
request IBulkInsertDiskRequest

BulkInsertDiskRequest 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): Disks;

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

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

createSnapshot(request, callback)

public createSnapshot(request: google.cloud.compute.v1.ICreateSnapshotDiskRequest, callback: google.cloud.compute.v1.Disks.CreateSnapshotCallback): void;

Calls CreateSnapshot.

Parameters
Name Description
request ICreateSnapshotDiskRequest

CreateSnapshotDiskRequest message or plain object

callback CreateSnapshotCallback

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

Returns
Type Description
void

createSnapshot(request)

public createSnapshot(request: google.cloud.compute.v1.ICreateSnapshotDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls CreateSnapshot.

Parameter
Name Description
request ICreateSnapshotDiskRequest

CreateSnapshotDiskRequest message or plain object

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

Promise

delete(request, callback)

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

Calls Delete.

Parameters
Name Description
request IDeleteDiskRequest

DeleteDiskRequest 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.IDeleteDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Delete.

Parameter
Name Description
request IDeleteDiskRequest

DeleteDiskRequest message or plain object

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

Promise

get(request, callback)

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

Calls Get.

Parameters
Name Description
request IGetDiskRequest

GetDiskRequest message or plain object

callback GetCallback

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

Returns
Type Description
void

get(request)

public get(request: google.cloud.compute.v1.IGetDiskRequest): Promise<google.cloud.compute.v1.Disk>;

Calls Get.

Parameter
Name Description
request IGetDiskRequest

GetDiskRequest message or plain object

Returns
Type Description
Promise<google.cloud.compute.v1.Disk>

Promise

getIamPolicy(request, callback)

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

Calls GetIamPolicy.

Parameters
Name Description
request IGetIamPolicyDiskRequest

GetIamPolicyDiskRequest 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.IGetIamPolicyDiskRequest): Promise<google.cloud.compute.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name Description
request IGetIamPolicyDiskRequest

GetIamPolicyDiskRequest message or plain object

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

Promise

insert(request, callback)

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

Calls Insert.

Parameters
Name Description
request IInsertDiskRequest

InsertDiskRequest 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.IInsertDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Insert.

Parameter
Name Description
request IInsertDiskRequest

InsertDiskRequest message or plain object

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

Promise

list(request, callback)

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

Calls List.

Parameters
Name Description
request IListDisksRequest

ListDisksRequest message or plain object

callback ListCallback

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

Returns
Type Description
void

list(request)

public list(request: google.cloud.compute.v1.IListDisksRequest): Promise<google.cloud.compute.v1.DiskList>;

Calls List.

Parameter
Name Description
request IListDisksRequest

ListDisksRequest message or plain object

Returns
Type Description
Promise<google.cloud.compute.v1.DiskList>

Promise

removeResourcePolicies(request, callback)

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

Calls RemoveResourcePolicies.

Parameters
Name Description
request IRemoveResourcePoliciesDiskRequest

RemoveResourcePoliciesDiskRequest 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.IRemoveResourcePoliciesDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls RemoveResourcePolicies.

Parameter
Name Description
request IRemoveResourcePoliciesDiskRequest

RemoveResourcePoliciesDiskRequest message or plain object

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

Promise

resize(request, callback)

public resize(request: google.cloud.compute.v1.IResizeDiskRequest, callback: google.cloud.compute.v1.Disks.ResizeCallback): void;

Calls Resize.

Parameters
Name Description
request IResizeDiskRequest

ResizeDiskRequest message or plain object

callback ResizeCallback

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

Returns
Type Description
void

resize(request)

public resize(request: google.cloud.compute.v1.IResizeDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Resize.

Parameter
Name Description
request IResizeDiskRequest

ResizeDiskRequest message or plain object

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

Promise

setIamPolicy(request, callback)

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

Calls SetIamPolicy.

Parameters
Name Description
request ISetIamPolicyDiskRequest

SetIamPolicyDiskRequest 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.ISetIamPolicyDiskRequest): Promise<google.cloud.compute.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name Description
request ISetIamPolicyDiskRequest

SetIamPolicyDiskRequest message or plain object

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

Promise

setLabels(request, callback)

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

Calls SetLabels.

Parameters
Name Description
request ISetLabelsDiskRequest

SetLabelsDiskRequest 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.ISetLabelsDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetLabels.

Parameter
Name Description
request ISetLabelsDiskRequest

SetLabelsDiskRequest message or plain object

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

Promise

startAsyncReplication(request, callback)

public startAsyncReplication(request: google.cloud.compute.v1.IStartAsyncReplicationDiskRequest, callback: google.cloud.compute.v1.Disks.StartAsyncReplicationCallback): void;

Calls StartAsyncReplication.

Parameters
Name Description
request IStartAsyncReplicationDiskRequest

StartAsyncReplicationDiskRequest message or plain object

callback StartAsyncReplicationCallback

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

Returns
Type Description
void

startAsyncReplication(request)

public startAsyncReplication(request: google.cloud.compute.v1.IStartAsyncReplicationDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls StartAsyncReplication.

Parameter
Name Description
request IStartAsyncReplicationDiskRequest

StartAsyncReplicationDiskRequest message or plain object

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

Promise

stopAsyncReplication(request, callback)

public stopAsyncReplication(request: google.cloud.compute.v1.IStopAsyncReplicationDiskRequest, callback: google.cloud.compute.v1.Disks.StopAsyncReplicationCallback): void;

Calls StopAsyncReplication.

Parameters
Name Description
request IStopAsyncReplicationDiskRequest

StopAsyncReplicationDiskRequest message or plain object

callback StopAsyncReplicationCallback

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

Returns
Type Description
void

stopAsyncReplication(request)

public stopAsyncReplication(request: google.cloud.compute.v1.IStopAsyncReplicationDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls StopAsyncReplication.

Parameter
Name Description
request IStopAsyncReplicationDiskRequest

StopAsyncReplicationDiskRequest message or plain object

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

Promise

stopGroupAsyncReplication(request, callback)

public stopGroupAsyncReplication(request: google.cloud.compute.v1.IStopGroupAsyncReplicationDiskRequest, callback: google.cloud.compute.v1.Disks.StopGroupAsyncReplicationCallback): void;

Calls StopGroupAsyncReplication.

Parameters
Name Description
request IStopGroupAsyncReplicationDiskRequest

StopGroupAsyncReplicationDiskRequest message or plain object

callback StopGroupAsyncReplicationCallback

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

Returns
Type Description
void

stopGroupAsyncReplication(request)

public stopGroupAsyncReplication(request: google.cloud.compute.v1.IStopGroupAsyncReplicationDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls StopGroupAsyncReplication.

Parameter
Name Description
request IStopGroupAsyncReplicationDiskRequest

StopGroupAsyncReplicationDiskRequest message or plain object

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

Promise

testIamPermissions(request, callback)

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

Calls TestIamPermissions.

Parameters
Name Description
request ITestIamPermissionsDiskRequest

TestIamPermissionsDiskRequest 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.ITestIamPermissionsDiskRequest): Promise<google.cloud.compute.v1.TestPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name Description
request ITestIamPermissionsDiskRequest

TestIamPermissionsDiskRequest message or plain object

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

Promise

update(request, callback)

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

Calls Update.

Parameters
Name Description
request IUpdateDiskRequest

UpdateDiskRequest 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.IUpdateDiskRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Update.

Parameter
Name Description
request IUpdateDiskRequest

UpdateDiskRequest message or plain object

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

Promise