@google-cloud/compute

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 InstanceGroups API. * @class * @memberof v1beta */ export declare class InstanceGroupsClient { 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; }; instanceGroupsStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of InstanceGroupsClient. * * @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 InstanceGroupsClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * Initialize the client. * Performs asynchronous operations (such as authentication) and prepares the client. * This function will be called automatically when any class method is called for the * first time, but if you need to initialize it before calling an actual method, * feel free to call initialize() directly. * * You can await on this method if you want to make sure the client is initialized. * * @returns {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; /** * Adds a list of instances to the specified instance group. All of the * instances in the instance group must be in the same network/subnetwork. * Read * Adding instances for more information. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroup * The name of the instance group where you are adding instances. * @param {google.cloud.compute.v1beta.InstanceGroupsAddInstancesRequest} request.instanceGroupsAddInstancesRequestResource * The body resource for this request * @param {string} request.project * Project ID for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.zone * The name of the zone * where the instance group is located. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/instance_groups.add_instances.js</caption> * region_tag:compute_v1beta_generated_InstanceGroups_AddInstances_async */ addInstances(request?: protos.google.cloud.compute.v1beta.IAddInstancesInstanceGroupRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; addInstances(request: protos.google.cloud.compute.v1beta.IAddInstancesInstanceGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddInstancesInstanceGroupRequest | null | undefined, {} | null | undefined>): void; addInstances(request: protos.google.cloud.compute.v1beta.IAddInstancesInstanceGroupRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddInstancesInstanceGroupRequest | null | undefined, {} | null | undefined>): void; /** * Deletes the specified instance group. The instances in the group are not * deleted. Note that instance group must not belong to a backend service. * Read * Deleting an instance group for more information. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroup * The name of the instance group to delete. * @param {string} request.project * Project ID for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.zone * The name of the zone * where the instance group is located. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/instance_groups.delete.js</caption> * region_tag:compute_v1beta_generated_InstanceGroups_Delete_async */ delete(request?: protos.google.cloud.compute.v1beta.IDeleteInstanceGroupRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; delete(request: protos.google.cloud.compute.v1beta.IDeleteInstanceGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteInstanceGroupRequest | null | undefined, {} | null | undefined>): void; delete(request: protos.google.cloud.compute.v1beta.IDeleteInstanceGroupRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteInstanceGroupRequest | null | undefined, {} | null | undefined>): void; /** * Returns the specified zonal instance group. Get a list of available zonal * instance groups by making a list() request. * * For managed instance groups, use theinstanceGroupManagers * or regionInstanceGroupManagers * methods instead. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroup * The name of the instance group. * @param {string} request.project * Project ID for this request. * @param {string} request.zone * The name of the zone * where the instance group is located. * @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.v1beta.InstanceGroup|InstanceGroup}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1beta/instance_groups.get.js</caption> * region_tag:compute_v1beta_generated_InstanceGroups_Get_async */ get(request?: protos.google.cloud.compute.v1beta.IGetInstanceGroupRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.IInstanceGroup, protos.google.cloud.compute.v1beta.IGetInstanceGroupRequest | undefined, {} | undefined ]>; get(request: protos.google.cloud.compute.v1beta.IGetInstanceGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IInstanceGroup, protos.google.cloud.compute.v1beta.IGetInstanceGroupRequest | null | undefined, {} | null | undefined>): void; get(request: protos.google.cloud.compute.v1beta.IGetInstanceGroupRequest, callback: Callback<protos.google.cloud.compute.v1beta.IInstanceGroup, protos.google.cloud.compute.v1beta.IGetInstanceGroupRequest | null | undefined, {} | null | undefined>): void; /** * Creates an instance group in the specified project using the * parameters that are included in the request. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.compute.v1beta.InstanceGroup} request.instanceGroupResource * The body resource for this request * @param {string} request.project * Project ID for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.zone * The name of the zone * where you want to create the instance group. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/instance_groups.insert.js</caption> * region_tag:compute_v1beta_generated_InstanceGroups_Insert_async */ insert(request?: protos.google.cloud.compute.v1beta.IInsertInstanceGroupRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; insert(request: protos.google.cloud.compute.v1beta.IInsertInstanceGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertInstanceGroupRequest | null | undefined, {} | null | undefined>): void; insert(request: protos.google.cloud.compute.v1beta.IInsertInstanceGroupRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertInstanceGroupRequest | null | undefined, {} | null | undefined>): void; /** * Removes one or more instances from the specified instance group, but does * not delete those 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 before the VM instance is removed or deleted. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroup * The name of the instance group where the specified instances will be * removed. * @param {google.cloud.compute.v1beta.InstanceGroupsRemoveInstancesRequest} request.instanceGroupsRemoveInstancesRequestResource * The body resource for this request * @param {string} request.project * Project ID for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.zone * The name of the zone * where the instance group is located. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/instance_groups.remove_instances.js</caption> * region_tag:compute_v1beta_generated_InstanceGroups_RemoveInstances_async */ removeInstances(request?: protos.google.cloud.compute.v1beta.IRemoveInstancesInstanceGroupRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; removeInstances(request: protos.google.cloud.compute.v1beta.IRemoveInstancesInstanceGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IRemoveInstancesInstanceGroupRequest | null | undefined, {} | null | undefined>): void; removeInstances(request: protos.google.cloud.compute.v1beta.IRemoveInstancesInstanceGroupRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IRemoveInstancesInstanceGroupRequest | null | undefined, {} | null | undefined>): void; /** * Sets the named ports for the specified instance group. * * @param {Object} request * The request object that will be sent. * @param {string} request.instanceGroup * The name of the instance group where the named ports are updated. * @param {google.cloud.compute.v1beta.InstanceGroupsSetNamedPortsRequest} request.instanceGroupsSetNamedPortsRequestResource * The body resource for this request * @param {string} request.project * Project ID for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.zone * The name of the zone * where the instance group is located. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/instance_groups.set_named_ports.js</caption> * region_tag:compute_v1beta_generated_InstanceGroups_SetNamedPorts_async */ setNamedPorts(request?: protos.google.cloud.compute.v1beta.ISetNamedPortsInstanceGroupRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; setNamedPorts(request: protos.google.cloud.compute.v1beta.ISetNamedPortsInstanceGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.ISetNamedPortsInstanceGroupRequest | null | undefined, {} | null | undefined>): void; setNamedPorts(request: protos.google.cloud.compute.v1beta.ISetNamedPortsInstanceGroupRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.ISetNamedPortsInstanceGroupRequest | null | undefined, {} | null | undefined>): void; /** * Returns permissions that a caller has on the specified resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.resource * Name or id of the resource for this request. * @param {google.cloud.compute.v1beta.TestPermissionsRequest} request.testPermissionsRequestResource * The body resource for this request * @param {string} request.zone * The name of the zone for this request. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.compute.v1beta.TestPermissionsResponse|TestPermissionsResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1beta/instance_groups.test_iam_permissions.js</caption> * region_tag:compute_v1beta_generated_InstanceGroups_TestIamPermissions_async */ testIamPermissions(request?: protos.google.cloud.compute.v1beta.ITestIamPermissionsInstanceGroupRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsInstanceGroupRequest | undefined, {} | undefined ]>; testIamPermissions(request: protos.google.cloud.compute.v1beta.ITestIamPermissionsInstanceGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsInstanceGroupRequest | null | undefined, {} | null | undefined>): void; testIamPermissions(request: protos.google.cloud.compute.v1beta.ITestIamPermissionsInstanceGroupRequest, callback: Callback<protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsInstanceGroupRequest | null | undefined, {} | null | undefined>): void; /** * Retrieves the list of instance groups and sorts them by zone. * * To prevent failure, Google recommends that you set the * `returnPartialSuccess` parameter to `true`. * * `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 {boolean} request.includeAllScopes * Indicates whether every visible scope for each scope type (zone, region, * global) should be included in the response. For new resource types added * after this field, the flag has no effect as new resource types will always * include every visible scope for each scope type in response. For resource * types which predate this field, if this flag is omitted or false, only * scopes of the scope types where the resource type is expected to be found * will be included. * @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 {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 {number} request.serviceProjectNumber * The Shared VPC service project id or service project number for which * aggregated list request is invoked for subnetworks list-usable api. * @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 * as tuple [string, {@link protos.google.cloud.compute.v1beta.InstanceGroupsScopedList|InstanceGroupsScopedList}]. 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 <caption>include:samples/generated/v1beta/instance_groups.aggregated_list.js</caption> * region_tag:compute_v1beta_generated_InstanceGroups_AggregatedList_async */ aggregatedListAsync(request?: protos.google.cloud.compute.v1beta.IAggregatedListInstanceGroupsRequest, options?: CallOptions): AsyncIterable<[string, protos.google.cloud.compute.v1beta.IInstanceGroupsScopedList]>; /** * Retrieves the list of zonal instance group resources contained within the * specified zone. * * For managed instance groups, use theinstanceGroupManagers * or regionInstanceGroupManagers * methods instead. * * @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 {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 {string} request.zone * The name of thezone * where the instance group is located. * @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.v1beta.InstanceGroup|InstanceGroup}. * 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.v1beta.IListInstanceGroupsRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.IInstanceGroup[], protos.google.cloud.compute.v1beta.IListInstanceGroupsRequest | null, protos.google.cloud.compute.v1beta.IInstanceGroupList ]>; list(request: protos.google.cloud.compute.v1beta.IListInstanceGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListInstanceGroupsRequest, protos.google.cloud.compute.v1beta.IInstanceGroupList | null | undefined, protos.google.cloud.compute.v1beta.IInstanceGroup>): void; list(request: protos.google.cloud.compute.v1beta.IListInstanceGroupsRequest, callback: PaginationCallback<protos.google.cloud.compute.v1beta.IListInstanceGroupsRequest, protos.google.cloud.compute.v1beta.IInstanceGroupList | null | undefined, protos.google.cloud.compute.v1beta.IInstanceGroup>): 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 {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 {string} request.zone * The name of thezone * where the instance group is located. * @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.v1beta.InstanceGroup|InstanceGroup} 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.v1beta.IListInstanceGroupsRequest, 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 `n