@google-cloud/compute
Version:
Google Compute Engine Client Library for Node.js
786 lines • 70.7 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* The RegionDisks API.
* @class
* @memberof v1
*/
export declare class RegionDisksClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
regionDisksStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of RegionDisksClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new RegionDisksClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* 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 {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* 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.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* The disk name for this request.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {google.cloud.compute.v1.RegionDisksAddResourcePoliciesRequest} request.regionDisksAddResourcePoliciesRequestResource
* The body resource for this request
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.add_resource_policies.js</caption>
* region_tag:compute_v1_generated_RegionDisks_AddResourcePolicies_async
*/
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
]>;
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;
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;
/**
* Bulk create a set of disks.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.compute.v1.BulkInsertDiskResource} request.bulkInsertDiskResourceResource
* The body resource for this request
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.bulk_insert.js</caption>
* region_tag:compute_v1_generated_RegionDisks_BulkInsert_async
*/
bulkInsert(request?: protos.google.cloud.compute.v1.IBulkInsertRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
bulkInsert(request: protos.google.cloud.compute.v1.IBulkInsertRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IBulkInsertRegionDiskRequest | null | undefined, {} | null | undefined>): void;
bulkInsert(request: protos.google.cloud.compute.v1.IBulkInsertRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IBulkInsertRegionDiskRequest | null | undefined, {} | null | undefined>): void;
/**
* 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.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* Name of the regional persistent disk to snapshot.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* Name of the region for this request.
* @param {string} request.requestId
* 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).
* @param {google.cloud.compute.v1.Snapshot} request.snapshotResource
* The body resource for this request
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.create_snapshot.js</caption>
* region_tag:compute_v1_generated_RegionDisks_CreateSnapshot_async
*/
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
]>;
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;
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;
/**
* 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 anysnapshots
* previously made from the disk. You must separatelydelete
* snapshots.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* Name of the regional persistent disk to delete.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* Name of the region for this request.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.delete.js</caption>
* region_tag:compute_v1_generated_RegionDisks_Delete_async
*/
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
]>;
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;
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;
/**
* Returns a specified regional persistent disk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* Name of the regional persistent disk to return.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* Name of the region for this request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Disk|Disk}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/region_disks.get.js</caption>
* region_tag:compute_v1_generated_RegionDisks_Get_async
*/
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
]>;
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;
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;
/**
* Gets the access control policy for a resource. May be empty if no such
* policy or resource exists.
*
* @param {Object} request
* The request object that will be sent.
* @param {number} request.optionsRequestedPolicyVersion
* Requested IAM Policy version.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {string} request.resource
* Name or id of the resource for this request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/region_disks.get_iam_policy.js</caption>
* region_tag:compute_v1_generated_RegionDisks_GetIamPolicy_async
*/
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
]>;
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;
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;
/**
* Creates a persistent regional disk in the specified project using the data
* included in the request.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.compute.v1.Disk} request.diskResource
* The body resource for this request
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* Name of the region for this request.
* @param {string} request.requestId
* 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).
* @param {string} request.sourceImage
* Source image to restore onto a disk. This field is optional.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.insert.js</caption>
* region_tag:compute_v1_generated_RegionDisks_Insert_async
*/
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
]>;
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;
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;
/**
* Removes resource policies from a regional disk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* The disk name for this request.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {google.cloud.compute.v1.RegionDisksRemoveResourcePoliciesRequest} request.regionDisksRemoveResourcePoliciesRequestResource
* The body resource for this request
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.remove_resource_policies.js</caption>
* region_tag:compute_v1_generated_RegionDisks_RemoveResourcePolicies_async
*/
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
]>;
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;
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;
/**
* Resizes the specified regional persistent disk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* Name of the regional persistent disk.
* @param {string} request.project
* The project ID for this request.
* @param {string} request.region
* Name of the region for this request.
* @param {google.cloud.compute.v1.RegionDisksResizeRequest} request.regionDisksResizeRequestResource
* The body resource for this request
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.resize.js</caption>
* region_tag:compute_v1_generated_RegionDisks_Resize_async
*/
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
]>;
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;
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;
/**
* Sets the access control policy on the specified resource.
* Replaces any existing policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {google.cloud.compute.v1.RegionSetPolicyRequest} request.regionSetPolicyRequestResource
* The body resource for this request
* @param {string} request.resource
* Name or id of the resource for this request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/region_disks.set_iam_policy.js</caption>
* region_tag:compute_v1_generated_RegionDisks_SetIamPolicy_async
*/
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
]>;
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;
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;
/**
* Sets the labels on the target regional disk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The region for this request.
* @param {google.cloud.compute.v1.RegionSetLabelsRequest} request.regionSetLabelsRequestResource
* The body resource for this request
* @param {string} request.requestId
* 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).
* @param {string} request.resource
* Name or id of the resource for this request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.set_labels.js</caption>
* region_tag:compute_v1_generated_RegionDisks_SetLabels_async
*/
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
]>;
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;
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;
/**
* Starts asynchronous replication.
* Must be invoked on the primary disk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* The name of the persistent disk.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {google.cloud.compute.v1.RegionDisksStartAsyncReplicationRequest} request.regionDisksStartAsyncReplicationRequestResource
* The body resource for this request
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.start_async_replication.js</caption>
* region_tag:compute_v1_generated_RegionDisks_StartAsyncReplication_async
*/
startAsyncReplication(request?: protos.google.cloud.compute.v1.IStartAsyncReplicationRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
startAsyncReplication(request: protos.google.cloud.compute.v1.IStartAsyncReplicationRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IStartAsyncReplicationRegionDiskRequest | null | undefined, {} | null | undefined>): void;
startAsyncReplication(request: protos.google.cloud.compute.v1.IStartAsyncReplicationRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IStartAsyncReplicationRegionDiskRequest | null | undefined, {} | null | undefined>): void;
/**
* Stops asynchronous replication.
* Can be invoked either on the primary or on the secondary disk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* The name of the persistent disk.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.stop_async_replication.js</caption>
* region_tag:compute_v1_generated_RegionDisks_StopAsyncReplication_async
*/
stopAsyncReplication(request?: protos.google.cloud.compute.v1.IStopAsyncReplicationRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
stopAsyncReplication(request: protos.google.cloud.compute.v1.IStopAsyncReplicationRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IStopAsyncReplicationRegionDiskRequest | null | undefined, {} | null | undefined>): void;
stopAsyncReplication(request: protos.google.cloud.compute.v1.IStopAsyncReplicationRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IStopAsyncReplicationRegionDiskRequest | null | undefined, {} | null | undefined>): void;
/**
* Stops asynchronous replication for a consistency group of disks.
* Can be invoked either in the primary or secondary scope.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.compute.v1.DisksStopGroupAsyncReplicationResource} request.disksStopGroupAsyncReplicationResourceResource
* The body resource for this request
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request. This must be the region of the
* primary or secondary disks in the consistency group.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1/region_disks.stop_group_async_replication.js</caption>
* region_tag:compute_v1_generated_RegionDisks_StopGroupAsyncReplication_async
*/
stopGroupAsyncReplication(request?: protos.google.cloud.compute.v1.IStopGroupAsyncReplicationRegionDiskRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
stopGroupAsyncReplication(request: protos.google.cloud.compute.v1.IStopGroupAsyncReplicationRegionDiskRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IStopGroupAsyncReplicationRegionDiskRequest | null | undefined, {} | null | undefined>): void;
stopGroupAsyncReplication(request: protos.google.cloud.compute.v1.IStopGroupAsyncReplicationRegionDiskRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IStopGroupAsyncReplicationRegionDiskRequest | null | undefined, {} | null | undefined>): void;
/**
* Returns permissions that a caller has on the specified resource.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {string} request.resource
* Name or id of the resource for this request.
* @param {google.cloud.compute.v1.TestPermissionsRequest} request.testPermissionsRequestResource
* The body resource for this request
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/region_disks.test_iam_permissions.js</caption>
* region_tag:compute_v1_generated_RegionDisks_TestIamPermissions_async
*/
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
]>;
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;
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;
/**
* Update the specified disk with the data included in the request. Update is
* performed only on selected fields included as part of update-mask. Only the
* following fields can be modified: user_license.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.disk
* The disk name for this request.
* @param {google.cloud.compute.v1.Disk} request.diskResource
* The body resource for this request
* @param {string} request.paths
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* The name of the region for this request.
* @param {string} request.requestId
* 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, consi