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 RegionInstanceGroupManagers API. * @class * @memberof v1 */ export declare class RegionInstanceGroupManagersClient { 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; }; regionInstanceGroupManagersStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of RegionInstanceGroupManagersClient. * * @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 RegionInstanceGroupManagersClient({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; getProjectId(callback: Callback): void; /** * Flags the specified instances to be immediately removed from the managed * instance group. Abandoning an instance does not delete the * instance, but it does remove the instance from any target pools that are * applied by the managed instance group. This method reduces thetargetSize of the managed instance group by the * number of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have * not yet been removed from the group. You must separately verify the * status of the abandoning action with thelistmanagedinstances * method. * * If the group is part of a backend * service that has enabled * connection draining, it can take up to 60 seconds after the connection * draining duration has elapsed before the VM instance is removed or deleted. * * You can specify a maximum of 1000 instances with this method per request. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersAbandonInstancesRequest} request.regionInstanceGroupManagersAbandonInstancesRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.abandon_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_AbandonInstances_async */ abandonInstances(request?: protos.google.cloud.compute.v1.IAbandonInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; abandonInstances(request: protos.google.cloud.compute.v1.IAbandonInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; abandonInstances(request: protos.google.cloud.compute.v1.IAbandonInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Apply updates to selected instances the managed instance group. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * The name of the managed instance group, should conform to RFC1035. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request, should conform to RFC1035. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersApplyUpdatesRequest} request.regionInstanceGroupManagersApplyUpdatesRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.apply_updates_to_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_ApplyUpdatesToInstances_async */ applyUpdatesToInstances(request?: protos.google.cloud.compute.v1.IApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; applyUpdatesToInstances(request: protos.google.cloud.compute.v1.IApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; applyUpdatesToInstances(request: protos.google.cloud.compute.v1.IApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Creates instances with per-instance configurations in this regional managed * instance group. Instances are created using the current instance template. * The create instances operation is marked DONE if * the createInstances request is successful. The underlying * actions take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances * method. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * The name of the managed instance group. * It should conform to RFC1035. * @param {string} request.project * Project ID for this request. * @param {string} request.region * The name of theregion * where the managed instance group is located. * It should conform to RFC1035. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersCreateInstancesRequest} request.regionInstanceGroupManagersCreateInstancesRequestResource * 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. * * 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 include:samples/generated/v1/region_instance_group_managers.create_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_CreateInstances_async */ createInstances(request?: protos.google.cloud.compute.v1.ICreateInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; createInstances(request: protos.google.cloud.compute.v1.ICreateInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; createInstances(request: protos.google.cloud.compute.v1.ICreateInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Deletes the specified managed instance group and all of the instances * in that group. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group to delete. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping 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 include:samples/generated/v1/region_instance_group_managers.delete.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_Delete_async */ delete(request?: protos.google.cloud.compute.v1.IDeleteRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; delete(request: protos.google.cloud.compute.v1.IDeleteRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; delete(request: protos.google.cloud.compute.v1.IDeleteRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Flags the specified instances in the managed instance group to be * immediately deleted. The instances are also removed from any target * pools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of * instances that you delete. * The deleteInstances operation is marked DONE if * the deleteInstances request is successful. The underlying * actions take additional time. You must separately verify the status of thedeleting action with thelistmanagedinstances * method. * * If the group is part of a backend * service that has enabled * connection draining, it can take up to 60 seconds after the connection * draining duration has elapsed before the VM instance is removed or deleted. * * You can specify a maximum of 1000 instances with this method per request. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersDeleteInstancesRequest} request.regionInstanceGroupManagersDeleteInstancesRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.delete_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_DeleteInstances_async */ deleteInstances(request?: protos.google.cloud.compute.v1.IDeleteInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; deleteInstances(request: protos.google.cloud.compute.v1.IDeleteInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; deleteInstances(request: protos.google.cloud.compute.v1.IDeleteInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Deletes selected per-instance configurations for the managed instance * group. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * The name of the managed instance group. It should conform to RFC1035. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request, should conform to RFC1035. * @param {google.cloud.compute.v1.RegionInstanceGroupManagerDeleteInstanceConfigReq} request.regionInstanceGroupManagerDeleteInstanceConfigReqResource * 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 include:samples/generated/v1/region_instance_group_managers.delete_per_instance_configs.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_DeletePerInstanceConfigs_async */ deletePerInstanceConfigs(request?: protos.google.cloud.compute.v1.IDeletePerInstanceConfigsRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; deletePerInstanceConfigs(request: protos.google.cloud.compute.v1.IDeletePerInstanceConfigsRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; deletePerInstanceConfigs(request: protos.google.cloud.compute.v1.IDeletePerInstanceConfigsRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Returns all of the details about the specified managed instance group. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group to return. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping 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.InstanceGroupManager|InstanceGroupManager}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.get.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_Get_async */ get(request?: protos.google.cloud.compute.v1.IGetRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1.IInstanceGroupManager, protos.google.cloud.compute.v1.IGetRegionInstanceGroupManagerRequest | undefined, {} | undefined ]>; get(request: protos.google.cloud.compute.v1.IGetRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; get(request: protos.google.cloud.compute.v1.IGetRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Creates a managed instance group using the information that you specify * in the request. After the group is created, instances in the group are * created using the specified instance template. * This operation is marked as DONE when the group is created * even if the instances in the group have not yet been created. You must * separately verify the status of the individual instances with thelistmanagedinstances * method. * * A regional managed instance group can contain up to 2000 instances. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.compute.v1.InstanceGroupManager} request.instanceGroupManagerResource * The body resource for this request * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping 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 include:samples/generated/v1/region_instance_group_managers.insert.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_Insert_async */ insert(request?: protos.google.cloud.compute.v1.IInsertRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; insert(request: protos.google.cloud.compute.v1.IInsertRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; insert(request: protos.google.cloud.compute.v1.IInsertRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Updates a managed instance group using the information that you specify * in the request. * This operation is marked as DONE when the group is patched * even if the instances in the group are still in the process of being * patched. You must separately verify the status of the individual instances * with the listmanagedinstances * method. This method supportsPATCH * semantics and uses theJSON merge * patch format and processing rules. * * If you update your group to specify a new template or instance * configuration, it's possible that your intended specification for each VM * in the group is different from the current state of that VM. To learn how * to apply an updated configuration to the VMs in a MIG, seeUpdating instances in * a MIG. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * The name of the instance group manager. * @param {google.cloud.compute.v1.InstanceGroupManager} request.instanceGroupManagerResource * The body resource for this request * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping 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 include:samples/generated/v1/region_instance_group_managers.patch.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_Patch_async */ patch(request?: protos.google.cloud.compute.v1.IPatchRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; patch(request: protos.google.cloud.compute.v1.IPatchRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; patch(request: protos.google.cloud.compute.v1.IPatchRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Inserts or patches per-instance configurations for the managed instance * group. perInstanceConfig.name serves as a key used to * distinguish whether to perform insert or patch. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * The name of the managed instance group. * It should conform to RFC1035. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request, should conform to RFC1035. * @param {google.cloud.compute.v1.RegionInstanceGroupManagerPatchInstanceConfigReq} request.regionInstanceGroupManagerPatchInstanceConfigReqResource * 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 include:samples/generated/v1/region_instance_group_managers.patch_per_instance_configs.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_PatchPerInstanceConfigs_async */ patchPerInstanceConfigs(request?: protos.google.cloud.compute.v1.IPatchPerInstanceConfigsRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; patchPerInstanceConfigs(request: protos.google.cloud.compute.v1.IPatchPerInstanceConfigsRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; patchPerInstanceConfigs(request: protos.google.cloud.compute.v1.IPatchPerInstanceConfigsRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Flags the specified VM instances in the managed instance group to be * immediately recreated. Each instance is recreated using the group's current * configuration. This operation is marked as DONE when the flag * is set even if the instances have not yet been recreated. You must * separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking * the status of managed instances. * * If the group is part of a backend * service that has enabled * connection draining, it can take up to 60 seconds after the connection * draining duration has elapsed before the VM instance is removed or deleted. * * You can specify a maximum of 1000 instances with this method per request. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersRecreateRequest} request.regionInstanceGroupManagersRecreateRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.recreate_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_RecreateInstances_async */ recreateInstances(request?: protos.google.cloud.compute.v1.IRecreateInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; recreateInstances(request: protos.google.cloud.compute.v1.IRecreateInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; recreateInstances(request: protos.google.cloud.compute.v1.IRecreateInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Changes the intended size of the managed instance group. If you increase * the size, the group creates new instances using the current instance * template. If you decrease the size, the group deletes one or more * instances. * * The resize operation is marked DONE if theresize request is successful. The underlying actions take * additional time. You must separately verify the status of thecreating or deleting actions with thelistmanagedinstances * method. * * If the group is part of a backend * service that has enabled * connection draining, it can take up to 60 seconds after the connection * draining duration has elapsed before the VM instance is removed or deleted. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping 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 {number} request.size * Number of instances that should exist in this instance group * manager. * @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 include:samples/generated/v1/region_instance_group_managers.resize.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_Resize_async */ resize(request?: protos.google.cloud.compute.v1.IResizeRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; resize(request: protos.google.cloud.compute.v1.IResizeRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; resize(request: protos.google.cloud.compute.v1.IResizeRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Flags the specified instances in the managed instance group to be * resumed. This method increases thetargetSize and decreases the targetSuspendedSize * of the managed instance group by the number of instances that you resume. * The resumeInstances operation is marked DONE if * the resumeInstances request is successful. The underlying * actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances * method. * * In this request, you can only specify instances that are suspended. For * example, if an instance was previously suspended using the suspendInstances * method, it can be resumed using the resumeInstances method. * * If a health check is attached to the managed instance group, the specified * instances will be verified as healthy after they are resumed. * * You can specify a maximum of 1000 instances with this method per request. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersResumeInstancesRequest} request.regionInstanceGroupManagersResumeInstancesRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.resume_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_ResumeInstances_async */ resumeInstances(request?: protos.google.cloud.compute.v1.IResumeInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; resumeInstances(request: protos.google.cloud.compute.v1.IResumeInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; resumeInstances(request: protos.google.cloud.compute.v1.IResumeInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Sets the instance template to use when creating new instances or recreating * instances in this group. Existing instances are not affected. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * The name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersSetTemplateRequest} request.regionInstanceGroupManagersSetTemplateRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.set_instance_template.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_SetInstanceTemplate_async */ setInstanceTemplate(request?: protos.google.cloud.compute.v1.ISetInstanceTemplateRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; setInstanceTemplate(request: protos.google.cloud.compute.v1.ISetInstanceTemplateRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; setInstanceTemplate(request: protos.google.cloud.compute.v1.ISetInstanceTemplateRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Modifies the target pools to which all new instances in this group are * assigned. Existing instances in the group are not affected. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersSetTargetPoolsRequest} request.regionInstanceGroupManagersSetTargetPoolsRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.set_target_pools.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_SetTargetPools_async */ setTargetPools(request?: protos.google.cloud.compute.v1.ISetTargetPoolsRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; setTargetPools(request: protos.google.cloud.compute.v1.ISetTargetPoolsRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; setTargetPools(request: protos.google.cloud.compute.v1.ISetTargetPoolsRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Flags the specified instances in the managed instance group to be * started. This method increases thetargetSize and decreases the targetStoppedSize * of the managed instance group by the number of instances that you start. * The startInstances operation is marked DONE if * the startInstances request is successful. The underlying * actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances * method. * * In this request, you can only specify instances that are stopped. For * example, if an instance was previously stopped using the stopInstances * method, it can be started using the startInstances method. * * If a health check is attached to the managed instance group, the specified * instances will be verified as healthy after they are started. * * You can specify a maximum of 1000 instances with this method per request. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersStartInstancesRequest} request.regionInstanceGroupManagersStartInstancesRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.start_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_StartInstances_async */ startInstances(request?: protos.google.cloud.compute.v1.IStartInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; startInstances(request: protos.google.cloud.compute.v1.IStartInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; startInstances(request: protos.google.cloud.compute.v1.IStartInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Flags the specified instances in the managed instance group to be * immediately stopped. You can only specify instances that are running in * this request. This method reduces thetargetSize and increases the targetStoppedSize * of the managed instance group by the number of instances that you stop. * The stopInstances operation is marked DONE if * the stopInstances request is successful. The underlying * actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances * method. * * If the standbyPolicy.initialDelaySec field is set, the group * delays stopping the instances until initialDelaySec have * passed from instance.creationTimestamp (that is, when the * instance was created). This delay gives your application time to * set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there * will be zero delay. * * If the group is part of a backend * service that has enabled * connection draining, it can take up to 60 seconds after the connection * draining duration has elapsed before the VM instance is stopped. * * Stopped instances can be started using the startInstances * method. * * You can specify a maximum of 1000 instances with this method per request. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * The name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersStopInstancesRequest} request.regionInstanceGroupManagersStopInstancesRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.stop_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_StopInstances_async */ stopInstances(request?: protos.google.cloud.compute.v1.IStopInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; stopInstances(request: protos.google.cloud.compute.v1.IStopInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; stopInstances(request: protos.google.cloud.compute.v1.IStopInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Flags the specified instances in the managed instance group to be * immediately suspended. You can only specify instances that are running in * this request. This method reduces thetargetSize and increases the targetSuspendedSize * of the managed instance group by the number of instances that you suspend. * The suspendInstances operation is marked DONE if * the suspendInstances request is successful. The underlying * actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances * method. * * If the standbyPolicy.initialDelaySec field is set, the group * delays suspension of the instances until initialDelaySec have * passed from instance.creationTimestamp (that is, when the * instance was created). This delay gives your application time to * set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there * will be zero delay. * * If the group is part of a backend * service that has enabled * connection draining, it can take up to 60 seconds after the connection * draining duration has elapsed before the VM instance is suspended. * * Suspended instances can be resumed using the resumeInstances * method. * * You can specify a maximum of 1000 instances with this method per request. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * Name of the managed instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {google.cloud.compute.v1.RegionInstanceGroupManagersSuspendInstancesRequest} request.regionInstanceGroupManagersSuspendInstancesRequestResource * 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 include:samples/generated/v1/region_instance_group_managers.suspend_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_SuspendInstances_async */ suspendInstances(request?: protos.google.cloud.compute.v1.ISuspendInstancesRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; suspendInstances(request: protos.google.cloud.compute.v1.ISuspendInstancesRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; suspendInstances(request: protos.google.cloud.compute.v1.ISuspendInstancesRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Inserts or updates per-instance configurations for the managed instance * group. perInstanceConfig.name serves as a key used to * distinguish whether to perform insert or patch. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroupManager * The name of the managed instance group. * It should conform to RFC1035. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request, should conform to RFC1035. * @param {google.cloud.compute.v1.RegionInstanceGroupManagerUpdateInstanceConfigReq} request.regionInstanceGroupManagerUpdateInstanceConfigReqResource * 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 include:samples/generated/v1/region_instance_group_managers.update_per_instance_configs.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_UpdatePerInstanceConfigs_async */ updatePerInstanceConfigs(request?: protos.google.cloud.compute.v1.IUpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, options?: CallOptions): Promise<[ LROperation, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>; updatePerInstanceConfigs(request: protos.google.cloud.compute.v1.IUpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, options: CallOptions, callback: Callback): void; updatePerInstanceConfigs(request: protos.google.cloud.compute.v1.IUpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, callback: Callback): void; /** * Retrieves the list of managed instance groups that are contained * within the specified region. * * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @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 Array of {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager}. * 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list(request?: protos.google.cloud.compute.v1.IListRegionInstanceGroupManagersRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1.IInstanceGroupManager[], protos.google.cloud.compute.v1.IListRegionInstanceGroupManagersRequest | null, protos.google.cloud.compute.v1.IRegionInstanceGroupManagerList ]>; list(request: protos.google.cloud.compute.v1.IListRegionInstanceGroupManagersRequest, options: CallOptions, callback: PaginationCallback): void; list(request: protos.google.cloud.compute.v1.IListRegionInstanceGroupManagersRequest, callback: PaginationCallback): void; /** * Equivalent to `list`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager} 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream(request?: protos.google.cloud.compute.v1.IListRegionInstanceGroupManagersRequest, options?: CallOptions): Transform; /** * Equivalent to `list`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.list.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_List_async */ listAsync(request?: protos.google.cloud.compute.v1.IListRegionInstanceGroupManagersRequest, options?: CallOptions): AsyncIterable; /** * Lists all errors thrown by actions on instances for a given regional * managed instance group. The filter andorderBy query parameters are not supported. * * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. * It must be a string that meets the requirements in RFC1035, or an * unsigned long integer: must match regexp pattern: * (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * This should conform to RFC1035. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @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 Array of {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError}. * 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 `listErrorsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listErrors(request?: protos.google.cloud.compute.v1.IListErrorsRegionInstanceGroupManagersRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1.IInstanceManagedByIgmError[], protos.google.cloud.compute.v1.IListErrorsRegionInstanceGroupManagersRequest | null, protos.google.cloud.compute.v1.IRegionInstanceGroupManagersListErrorsResponse ]>; listErrors(request: protos.google.cloud.compute.v1.IListErrorsRegionInstanceGroupManagersRequest, options: CallOptions, callback: PaginationCallback): void; listErrors(request: protos.google.cloud.compute.v1.IListErrorsRegionInstanceGroupManagersRequest, callback: PaginationCallback): void; /** * Equivalent to `listErrors`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. * It must be a string that meets the requirements in RFC1035, or an * unsigned long integer: must match regexp pattern: * (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * This should conform to RFC1035. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError} 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 `listErrorsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listErrorsStream(request?: protos.google.cloud.compute.v1.IListErrorsRegionInstanceGroupManagersRequest, options?: CallOptions): Transform; /** * Equivalent to `listErrors`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. * It must be a string that meets the requirements in RFC1035, or an * unsigned long integer: must match regexp pattern: * (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * This should conform to RFC1035. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.list_errors.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_ListErrors_async */ listErrorsAsync(request?: protos.google.cloud.compute.v1.IListErrorsRegionInstanceGroupManagersRequest, options?: CallOptions): AsyncIterable; /** * Lists the instances in the managed instance group and instances that are * scheduled to be created. The list includes any current actions * that the group has scheduled for its instances. The orderBy * query parameter is not supported. The `pageToken` query parameter is * supported only if the group's `listManagedInstancesResults` field is set * to `PAGINATED`. * * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @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 Array of {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance}. * 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 `listManagedInstancesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listManagedInstances(request?: protos.google.cloud.compute.v1.IListManagedInstancesRegionInstanceGroupManagersRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1.IManagedInstance[], protos.google.cloud.compute.v1.IListManagedInstancesRegionInstanceGroupManagersRequest | null, protos.google.cloud.compute.v1.IRegionInstanceGroupManagersListInstancesResponse ]>; listManagedInstances(request: protos.google.cloud.compute.v1.IListManagedInstancesRegionInstanceGroupManagersRequest, options: CallOptions, callback: PaginationCallback): void; listManagedInstances(request: protos.google.cloud.compute.v1.IListManagedInstancesRegionInstanceGroupManagersRequest, callback: PaginationCallback): void; /** * Equivalent to `listManagedInstances`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance} 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 `listManagedInstancesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listManagedInstancesStream(request?: protos.google.cloud.compute.v1.IListManagedInstancesRegionInstanceGroupManagersRequest, options?: CallOptions): Transform; /** * Equivalent to `listManagedInstances`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.list_managed_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_ListManagedInstances_async */ listManagedInstancesAsync(request?: protos.google.cloud.compute.v1.IListManagedInstancesRegionInstanceGroupManagersRequest, options?: CallOptions): AsyncIterable; /** * Lists all of the per-instance configurations defined for the managed * instance group. The orderBy query parameter is not supported. * * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. It should conform to RFC1035. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request, should conform to RFC1035. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @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 Array of {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig}. * 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 `listPerInstanceConfigsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPerInstanceConfigs(request?: protos.google.cloud.compute.v1.IListPerInstanceConfigsRegionInstanceGroupManagersRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1.IPerInstanceConfig[], protos.google.cloud.compute.v1.IListPerInstanceConfigsRegionInstanceGroupManagersRequest | null, protos.google.cloud.compute.v1.IRegionInstanceGroupManagersListInstanceConfigsResp ]>; listPerInstanceConfigs(request: protos.google.cloud.compute.v1.IListPerInstanceConfigsRegionInstanceGroupManagersRequest, options: CallOptions, callback: PaginationCallback): void; listPerInstanceConfigs(request: protos.google.cloud.compute.v1.IListPerInstanceConfigsRegionInstanceGroupManagersRequest, callback: PaginationCallback): void; /** * Equivalent to `listPerInstanceConfigs`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. It should conform to RFC1035. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request, should conform to RFC1035. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig} 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 `listPerInstanceConfigsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPerInstanceConfigsStream(request?: protos.google.cloud.compute.v1.IListPerInstanceConfigsRegionInstanceGroupManagersRequest, options?: CallOptions): Transform; /** * Equivalent to `listPerInstanceConfigs`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {string} request.instanceGroupManager * The name of the managed instance group. It should conform to RFC1035. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region scoping this request, should conform to RFC1035. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.list_per_instance_configs.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_ListPerInstanceConfigs_async */ listPerInstanceConfigsAsync(request?: protos.google.cloud.compute.v1.IListPerInstanceConfigsRegionInstanceGroupManagersRequest, options?: CallOptions): AsyncIterable; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }