Class v1.InstanceGroupsClient (3.1.2) Stay organized with collections Save and categorize content based on your preferences.
The InstanceGroups API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts)
constructor(opts?:ClientOptions);Construct an instance of InstanceGroupsClient.
| Name | Description |
| opts | ClientOptions |
Properties
apiEndpoint
staticgetapiEndpoint():string;The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth:gax.GoogleAuth;descriptors
descriptors:Descriptors;innerApiCalls
innerApiCalls:{[name:string]:Function;};instanceGroupsStub
instanceGroupsStub?:Promise<{[name:string]:Function;}>;port
staticgetport():number;The port for this API service.
scopes
staticgetscopes():string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
staticgetservicePath():string;The DNS address for this API service.
warn
warn:(code:string,message:string,warnType?:string)=>void;Methods
addInstances(request, options)
addInstances(request?:protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;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.
| Name | Description |
| request | protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * The name of the instance group where you are adding instances. */// const instanceGroup = 'abc123'/** * The body resource for this request */// const instanceGroupsAddInstancesRequestResource = {}/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * The name of the zone where the instance group is located. */// const zone = 'abc123'// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallAddInstances(){// Construct requestconstrequest={instanceGroup,instanceGroupsAddInstancesRequestResource,project,zone,};// Run requestconstresponse=awaitcomputeClient.addInstances(request);console.log(response);}callAddInstances();addInstances(request, options, callback)
addInstances(request:protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest |
| options | CallOptions |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
addInstances(request, callback)
addInstances(request:protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
aggregatedListAsync(request, options)
aggregatedListAsync(request?:protos.google.cloud.compute.v1.IAggregatedListInstanceGroupsRequest,options?:CallOptions):AsyncIterable<[string,protos.google.cloud.compute.v1.IInstanceGroupsScopedList]>;Equivalent toaggregatedList, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Name | Description |
| request | protos.google.cloud.compute.v1.IAggregatedListInstanceGroupsRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| AsyncIterable<[ string, protos.google.cloud.compute.v1.IInstanceGroupsScopedList ]> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing as tuple [string, [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` */// const filter = 'abc123'/** * 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. */// const includeAllScopes = true/** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */// const maxResults = 1234/** * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */// const orderBy = 'abc123'/** * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */// const pageToken = 'abc123'/** * Project ID for this request. */// const project = 'my-project'/** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */// const returnPartialSuccess = true// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallAggregatedList(){// Construct requestconstrequest={project,};// Run requestconstiterable=awaitcomputeClient.aggregatedListAsync(request);forawait(const[key,value]ofiterable){console.log(response);}}callAggregatedList();close()
close():Promise<void>;Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Type | Description |
| Promise<void> | {Promise} A promise that resolves when the client is closed. |
delete(request, options)
delete(request?:protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;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.
| Name | Description |
| request | protos.google.cloud.compute.v1.IDeleteInstanceGroupRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * The name of the instance group to delete. */// const instanceGroup = 'abc123'/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * The name of the zone where the instance group is located. */// const zone = 'abc123'// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallDelete(){// Construct requestconstrequest={instanceGroup,project,zone,};// Run requestconstresponse=awaitcomputeClient.delete(request);console.log(response);}callDelete();delete(request, options, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest |
| options | CallOptions |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
delete(request, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
get(request, options)
get(request?:protos.google.cloud.compute.v1.IGetInstanceGroupRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IInstanceGroup,protos.google.cloud.compute.v1.IGetInstanceGroupRequest|undefined,{}|undefined]>;Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
| Name | Description |
| request | protos.google.cloud.compute.v1.IGetInstanceGroupRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Promise<[ protos.google.cloud.compute.v1.IInstanceGroup, protos.google.cloud.compute.v1.IGetInstanceGroupRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [InstanceGroup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * The name of the instance group. */// const instanceGroup = 'abc123'/** * Project ID for this request. */// const project = 'my-project'/** * The name of the zone where the instance group is located. */// const zone = 'abc123'// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallGet(){// Construct requestconstrequest={instanceGroup,project,zone,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();get(request, options, callback)
get(request:protos.google.cloud.compute.v1.IGetInstanceGroupRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IInstanceGroup,protos.google.cloud.compute.v1.IGetInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IGetInstanceGroupRequest |
| options | CallOptions |
| callback | Callback<protos.google.cloud.compute.v1.IInstanceGroup, protos.google.cloud.compute.v1.IGetInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
get(request, callback)
get(request:protos.google.cloud.compute.v1.IGetInstanceGroupRequest,callback:Callback<protos.google.cloud.compute.v1.IInstanceGroup,protos.google.cloud.compute.v1.IGetInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IGetInstanceGroupRequest |
| callback | Callback<protos.google.cloud.compute.v1.IInstanceGroup, protos.google.cloud.compute.v1.IGetInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
getProjectId()
getProjectId():Promise<string>;| Type | Description |
| Promise<string> |
getProjectId(callback)
getProjectId(callback:Callback<string,undefined,undefined>):void;| Name | Description |
| callback | Callback<string, undefined, undefined> |
| Type | Description |
| void |
initialize()
initialize():Promise<{[name:string]:Function;}>;Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Type | Description |
| Promise<{ [name: string]:Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
insert(request, options)
insert(request?:protos.google.cloud.compute.v1.IInsertInstanceGroupRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Creates an instance group in the specified project using the parameters that are included in the request.
| Name | Description |
| request | protos.google.cloud.compute.v1.IInsertInstanceGroupRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * The body resource for this request */// const instanceGroupResource = {}/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * The name of the zone where you want to create the instance group. */// const zone = 'abc123'// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallInsert(){// Construct requestconstrequest={instanceGroupResource,project,zone,};// Run requestconstresponse=awaitcomputeClient.insert(request);console.log(response);}callInsert();insert(request, options, callback)
insert(request:protos.google.cloud.compute.v1.IInsertInstanceGroupRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IInsertInstanceGroupRequest |
| options | CallOptions |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
insert(request, callback)
insert(request:protos.google.cloud.compute.v1.IInsertInstanceGroupRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IInsertInstanceGroupRequest |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
list(request, options)
list(request?:protos.google.cloud.compute.v1.IListInstanceGroupsRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IInstanceGroup[],protos.google.cloud.compute.v1.IListInstanceGroupsRequest|null,protos.google.cloud.compute.v1.IInstanceGroupList]>;Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstanceGroupsRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Promise<[ protos.google.cloud.compute.v1.IInstanceGroup[], protos.google.cloud.compute.v1.IListInstanceGroupsRequest | null, protos.google.cloud.compute.v1.IInstanceGroupList ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [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 |
list(request, options, callback)
list(request:protos.google.cloud.compute.v1.IListInstanceGroupsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListInstanceGroupsRequest,protos.google.cloud.compute.v1.IInstanceGroupList|null|undefined,protos.google.cloud.compute.v1.IInstanceGroup>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstanceGroupsRequest |
| options | CallOptions |
| callback | PaginationCallback<protos.google.cloud.compute.v1.IListInstanceGroupsRequest, protos.google.cloud.compute.v1.IInstanceGroupList | null | undefined, protos.google.cloud.compute.v1.IInstanceGroup> |
| Type | Description |
| void |
list(request, callback)
list(request:protos.google.cloud.compute.v1.IListInstanceGroupsRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListInstanceGroupsRequest,protos.google.cloud.compute.v1.IInstanceGroupList|null|undefined,protos.google.cloud.compute.v1.IInstanceGroup>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstanceGroupsRequest |
| callback | PaginationCallback<protos.google.cloud.compute.v1.IListInstanceGroupsRequest, protos.google.cloud.compute.v1.IInstanceGroupList | null | undefined, protos.google.cloud.compute.v1.IInstanceGroup> |
| Type | Description |
| void |
listAsync(request, options)
listAsync(request?:protos.google.cloud.compute.v1.IListInstanceGroupsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IInstanceGroup>;Equivalent tolist, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstanceGroupsRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| AsyncIterable<protos.google.cloud.compute.v1.IInstanceGroup> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [InstanceGroup]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` */// const filter = 'abc123'/** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */// const maxResults = 1234/** * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */// const orderBy = 'abc123'/** * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */// const pageToken = 'abc123'/** * Project ID for this request. */// const project = 'my-project'/** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */// const returnPartialSuccess = true/** * The name of the zone where the instance group is located. */// const zone = 'abc123'// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallList(){// Construct requestconstrequest={project,zone,};// Run requestconstiterable=awaitcomputeClient.listAsync(request);forawait(constresponseofiterable){console.log(response);}}callList();listInstances(request, options)
listInstances(request?:protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IInstanceWithNamedPorts[],protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest|null,protos.google.cloud.compute.v1.IInstanceGroupsListInstances]>;Lists the instances in the specified instance group. The orderBy query parameter is not supported.
| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Promise<[ protos.google.cloud.compute.v1.IInstanceWithNamedPorts[], protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest | null, protos.google.cloud.compute.v1.IInstanceGroupsListInstances ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [InstanceWithNamedPorts]. 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 |
listInstances(request, options, callback)
listInstances(request:protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest,protos.google.cloud.compute.v1.IInstanceGroupsListInstances|null|undefined,protos.google.cloud.compute.v1.IInstanceWithNamedPorts>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest |
| options | CallOptions |
| callback | PaginationCallback<protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest, protos.google.cloud.compute.v1.IInstanceGroupsListInstances | null | undefined, protos.google.cloud.compute.v1.IInstanceWithNamedPorts> |
| Type | Description |
| void |
listInstances(request, callback)
listInstances(request:protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest,protos.google.cloud.compute.v1.IInstanceGroupsListInstances|null|undefined,protos.google.cloud.compute.v1.IInstanceWithNamedPorts>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest |
| callback | PaginationCallback<protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest, protos.google.cloud.compute.v1.IInstanceGroupsListInstances | null | undefined, protos.google.cloud.compute.v1.IInstanceWithNamedPorts> |
| Type | Description |
| void |
listInstancesAsync(request, options)
listInstancesAsync(request?:protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IInstanceWithNamedPorts>;Equivalent tolistInstances, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| AsyncIterable<protos.google.cloud.compute.v1.IInstanceWithNamedPorts> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [InstanceWithNamedPorts]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` */// const filter = 'abc123'/** * The name of the instance group from which you want to generate a list of included instances. */// const instanceGroup = 'abc123'/** * The body resource for this request */// const instanceGroupsListInstancesRequestResource = {}/** * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */// const maxResults = 1234/** * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */// const orderBy = 'abc123'/** * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */// const pageToken = 'abc123'/** * Project ID for this request. */// const project = 'my-project'/** * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */// const returnPartialSuccess = true/** * The name of the zone where the instance group is located. */// const zone = 'abc123'// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallListInstances(){// Construct requestconstrequest={instanceGroup,instanceGroupsListInstancesRequestResource,project,zone,};// Run requestconstiterable=awaitcomputeClient.listInstancesAsync(request);forawait(constresponseofiterable){console.log(response);}}callListInstances();listInstancesStream(request, options)
listInstancesStream(request?:protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest,options?:CallOptions):Transform;Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.
| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Transform | {Stream} An object stream which emits an object representing [InstanceWithNamedPorts] 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 |
listStream(request, options)
listStream(request?:protos.google.cloud.compute.v1.IListInstanceGroupsRequest,options?:CallOptions):Transform;Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.
| Name | Description |
| request | protos.google.cloud.compute.v1.IListInstanceGroupsRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Transform | {Stream} An object stream which emits an object representing [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 |
removeInstances(request, options)
removeInstances(request?:protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;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.
| Name | Description |
| request | protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * The name of the instance group where the specified instances will be removed. */// const instanceGroup = 'abc123'/** * The body resource for this request */// const instanceGroupsRemoveInstancesRequestResource = {}/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * The name of the zone where the instance group is located. */// const zone = 'abc123'// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallRemoveInstances(){// Construct requestconstrequest={instanceGroup,instanceGroupsRemoveInstancesRequestResource,project,zone,};// Run requestconstresponse=awaitcomputeClient.removeInstances(request);console.log(response);}callRemoveInstances();removeInstances(request, options, callback)
removeInstances(request:protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest |
| options | CallOptions |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
removeInstances(request, callback)
removeInstances(request:protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
setNamedPorts(request, options)
setNamedPorts(request?:protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Sets the named ports for the specified instance group.
| Name | Description |
| request | protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * TODO(developer): Uncomment these variables before running the sample. *//** * The name of the instance group where the named ports are updated. */// const instanceGroup = 'abc123'/** * The body resource for this request */// const instanceGroupsSetNamedPortsRequestResource = {}/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'/** * The name of the zone where the instance group is located. */// const zone = 'abc123'// Imports the Compute libraryconst{InstanceGroupsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newInstanceGroupsClient();asyncfunctioncallSetNamedPorts(){// Construct requestconstrequest={instanceGroup,instanceGroupsSetNamedPortsRequestResource,project,zone,};// Run requestconstresponse=awaitcomputeClient.setNamedPorts(request);console.log(response);}callSetNamedPorts();setNamedPorts(request, options, callback)
setNamedPorts(request:protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest |
| options | CallOptions |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
setNamedPorts(request, callback)
setNamedPorts(request:protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest |
| callback | Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.