Package
@google-cloud/compute
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of RegionDisksClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
port
static get port(): number;
The port for this API service.
regionDisksStub
regionDisksStub?: Promise<{
[name: string]: Function;
}>;
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
addResourcePolicies(request, options)
addResourcePolicies(request?: protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The disk name for this request.
*/
// const disk = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* The name of the region for this request.
*/
// const region = 'us-central1'
/**
* The body resource for this request
*/
// const regionDisksAddResourcePoliciesRequestResource = {}
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callAddResourcePolicies() {
// Construct request
const request = {
disk,
project,
region,
regionDisksAddResourcePoliciesRequestResource,
};
// Run request
const response = await computeClient.addResourcePolicies(request);
console.log(response);
}
callAddResourcePolicies();
addResourcePolicies(request, options, callback)
addResourcePolicies(request: protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
addResourcePolicies(request, callback)
addResourcePolicies(request: protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddResourcePoliciesRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed.
|
createSnapshot(request, options)
createSnapshot(request?: protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the regional persistent disk to snapshot.
*/
// const disk = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* The body resource for this request
*/
// const snapshotResource = {}
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callCreateSnapshot() {
// Construct request
const request = {
disk,
project,
region,
snapshotResource,
};
// Run request
const response = await computeClient.createSnapshot(request);
console.log(response);
}
callCreateSnapshot();
createSnapshot(request, options, callback)
createSnapshot(request: protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
createSnapshot(request, callback)
createSnapshot(request: protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICreateSnapshotRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
delete(request, options)
delete(request?: protos.google.cloud.compute.v1.IDeleteRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the regional persistent disk to delete.
*/
// const disk = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callDelete() {
// Construct request
const request = {
disk,
project,
region,
};
// Run request
const response = await computeClient.delete(request);
console.log(response);
}
callDelete();
delete(request, options, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
delete(request, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
get(request, options)
get(request?: protos.google.cloud.compute.v1.IGetRegionDiskRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IDisk,
protos.google.cloud.compute.v1.IGetRegionDiskRequest | undefined,
{} | undefined
]>;
Returns a specified regional persistent disk.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.IDisk,
protos.google.cloud.compute.v1.IGetRegionDiskRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Disk]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the regional persistent disk to return.
*/
// const disk = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callGet() {
// Construct request
const request = {
disk,
project,
region,
};
// Run request
const response = await computeClient.get(request);
console.log(response);
}
callGet();
get(request, options, callback)
get(request: protos.google.cloud.compute.v1.IGetRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IDisk, protos.google.cloud.compute.v1.IGetRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IDisk, protos.google.cloud.compute.v1.IGetRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
get(request, callback)
get(request: protos.google.cloud.compute.v1.IGetRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IDisk, protos.google.cloud.compute.v1.IGetRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IDisk, protos.google.cloud.compute.v1.IGetRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, options)
getIamPolicy(request?: protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IPolicy,
protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest | undefined,
{} | undefined
]>;
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.IPolicy,
protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Requested IAM Policy version.
*/
// const optionsRequestedPolicyVersion = 1234
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* The name of the region for this request.
*/
// const region = 'us-central1'
/**
* Name or id of the resource for this request.
*/
// const resource = 'abc123'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callGetIamPolicy() {
// Construct request
const request = {
project,
region,
resource,
};
// Run request
const response = await computeClient.getIamPolicy(request);
console.log(response);
}
callGetIamPolicy();
getIamPolicy(request, options, callback)
getIamPolicy(request: protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, callback)
getIamPolicy(request: protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
insert(request, options)
insert(request?: protos.google.cloud.compute.v1.IInsertRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Creates a persistent regional disk in the specified project using the data included in the request.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IInsertRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The body resource for this request
*/
// const diskResource = {}
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Source image to restore onto a disk. This field is optional.
*/
// const sourceImage = 'abc123'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callInsert() {
// Construct request
const request = {
diskResource,
project,
region,
};
// Run request
const response = await computeClient.insert(request);
console.log(response);
}
callInsert();
insert(request, options, callback)
insert(request: protos.google.cloud.compute.v1.IInsertRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IInsertRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
insert(request, callback)
insert(request: protos.google.cloud.compute.v1.IInsertRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IInsertRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
list(request, options)
list(request?: protos.google.cloud.compute.v1.IListRegionDisksRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IDisk[],
protos.google.cloud.compute.v1.IListRegionDisksRequest | null,
protos.google.cloud.compute.v1.IDiskList
]>;
Retrieves the list of persistent disks contained within the specified region.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListRegionDisksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.IDisk[],
protos.google.cloud.compute.v1.IListRegionDisksRequest | null,
protos.google.cloud.compute.v1.IDiskList
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Disk]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
list(request, options, callback)
list(request: protos.google.cloud.compute.v1.IListRegionDisksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListRegionDisksRequest, protos.google.cloud.compute.v1.IDiskList | null | undefined, protos.google.cloud.compute.v1.IDisk>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListRegionDisksRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.compute.v1.IListRegionDisksRequest, protos.google.cloud.compute.v1.IDiskList | null | undefined, protos.google.cloud.compute.v1.IDisk>
|
Returns
list(request, callback)
list(request: protos.google.cloud.compute.v1.IListRegionDisksRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListRegionDisksRequest, protos.google.cloud.compute.v1.IDiskList | null | undefined, protos.google.cloud.compute.v1.IDisk>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListRegionDisksRequest
|
callback |
PaginationCallback<protos.google.cloud.compute.v1.IListRegionDisksRequest, protos.google.cloud.compute.v1.IDiskList | null | undefined, protos.google.cloud.compute.v1.IDisk>
|
Returns
listAsync(request, options)
listAsync(request?: protos.google.cloud.compute.v1.IListRegionDisksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.IDisk>;
Equivalent to list
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListRegionDisksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.IDisk> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Disk]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
*/
// const filter = 'abc123'
/**
* The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
*/
// const maxResults = 1234
/**
* Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
*/
// const orderBy = 'abc123'
/**
* Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
*/
// const pageToken = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
/**
* Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
*/
// const returnPartialSuccess = true
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callList() {
// Construct request
const request = {
project,
region,
};
// Run request
const iterable = await computeClient.listAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callList();
listStream(request, options)
listStream(request?: protos.google.cloud.compute.v1.IListRegionDisksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IListRegionDisksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Disk] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
removeResourcePolicies(request, options)
removeResourcePolicies(request?: protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Removes resource policies from a regional disk.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The disk name for this request.
*/
// const disk = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* The name of the region for this request.
*/
// const region = 'us-central1'
/**
* The body resource for this request
*/
// const regionDisksRemoveResourcePoliciesRequestResource = {}
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callRemoveResourcePolicies() {
// Construct request
const request = {
disk,
project,
region,
regionDisksRemoveResourcePoliciesRequestResource,
};
// Run request
const response = await computeClient.removeResourcePolicies(request);
console.log(response);
}
callRemoveResourcePolicies();
removeResourcePolicies(request, options, callback)
removeResourcePolicies(request: protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
removeResourcePolicies(request, callback)
removeResourcePolicies(request: protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveResourcePoliciesRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
resize(request, options)
resize(request?: protos.google.cloud.compute.v1.IResizeRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Resizes the specified regional persistent disk.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IResizeRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the regional persistent disk.
*/
// const disk = 'abc123'
/**
* The project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
/**
* The body resource for this request
*/
// const regionDisksResizeRequestResource = {}
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callResize() {
// Construct request
const request = {
disk,
project,
region,
regionDisksResizeRequestResource,
};
// Run request
const response = await computeClient.resize(request);
console.log(response);
}
callResize();
resize(request, options, callback)
resize(request: protos.google.cloud.compute.v1.IResizeRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IResizeRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IResizeRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IResizeRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
resize(request, callback)
resize(request: protos.google.cloud.compute.v1.IResizeRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IResizeRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IResizeRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IResizeRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, options)
setIamPolicy(request?: protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IPolicy,
protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest | undefined,
{} | undefined
]>;
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.IPolicy,
protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* The name of the region for this request.
*/
// const region = 'us-central1'
/**
* The body resource for this request
*/
// const regionSetPolicyRequestResource = {}
/**
* Name or id of the resource for this request.
*/
// const resource = 'abc123'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callSetIamPolicy() {
// Construct request
const request = {
project,
region,
regionSetPolicyRequestResource,
resource,
};
// Run request
const response = await computeClient.setIamPolicy(request);
console.log(response);
}
callSetIamPolicy();
setIamPolicy(request, options, callback)
setIamPolicy(request: protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, callback)
setIamPolicy(request: protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
setLabels(request, options)
setLabels(request?: protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Sets the labels on the target regional disk.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* The region for this request.
*/
// const region = 'us-central1'
/**
* The body resource for this request
*/
// const regionSetLabelsRequestResource = {}
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Name or id of the resource for this request.
*/
// const resource = 'abc123'
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callSetLabels() {
// Construct request
const request = {
project,
region,
regionSetLabelsRequestResource,
resource,
};
// Run request
const response = await computeClient.setLabels(request);
console.log(response);
}
callSetLabels();
setLabels(request, options, callback)
setLabels(request: protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
setLabels(request, callback)
setLabels(request: protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetLabelsRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, options)
testIamPermissions(request?: protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ITestPermissionsResponse,
(protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest | undefined),
{} | undefined
]>;
Returns permissions that a caller has on the specified resource.
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ITestPermissionsResponse,
(protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestPermissionsResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
|
Example
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* The name of the region for this request.
*/
// const region = 'us-central1'
/**
* Name or id of the resource for this request.
*/
// const resource = 'abc123'
/**
* The body resource for this request
*/
// const testPermissionsRequestResource = {}
// Imports the Compute library
const {RegionDisksClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new RegionDisksClient();
async function callTestIamPermissions() {
// Construct request
const request = {
project,
region,
resource,
testPermissionsRequestResource,
};
// Run request
const response = await computeClient.testIamPermissions(request);
console.log(response);
}
callTestIamPermissions();
testIamPermissions(request, options, callback)
testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, callback)
testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest
|
callback |
Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsRegionDiskRequest | null | undefined, {} | null | undefined>
|
Returns