Class v1.InstanceGroupsClient (3.0.0)

The InstanceGroups API. v1

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of InstanceGroupsClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

instanceGroupsStub

instanceGroupsStub?: Promise<{
        [name: string]: Function;
    }>;

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

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
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IAddInstancesInstanceGroupRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation \| undefined, {} \| undefined ]>

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;

Parameters

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>`

Returns

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;

Parameters

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>`

Returns

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 to aggregatedList, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IAggregatedListInstanceGroupsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

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.

Example


const iterable = client.aggregatedListAsync(request);
for await (const [key, value] of iterable) {
  // process response
}

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.

Returns

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
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IDeleteInstanceGroupRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation \| undefined, {} \| undefined ]>

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;

Parameters

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>`

Returns

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;

Parameters

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>`

Returns

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
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IGetInstanceGroupRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.compute.v1.IInstanceGroup, protos.google.cloud.compute.v1.IGetInstanceGroupRequest \| undefined, {} \| undefined ]>

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;

Parameters

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>`

Returns

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;

Parameters

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>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

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.

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

insert(request, options)

insert(request?: protos.google.cloud.compute.v1.IInsertInstanceGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IInsertInstanceGroupRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation \| undefined, {} \| undefined ]>

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;

Parameters

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>`

Returns

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;

Parameters

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>`

Returns

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
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListInstanceGroupsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.compute.v1.IInstanceGroup[], protos.google.cloud.compute.v1.IListInstanceGroupsRequest \| null, protos.google.cloud.compute.v1.IInstanceGroupList ]>

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;

Parameters

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>`

Returns

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;

Parameters

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>`

Returns

Type	Description
void

listAsync(request, options)

listAsync(request?: protos.google.cloud.compute.v1.IListInstanceGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.IInstanceGroup>;

Equivalent to list, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListInstanceGroupsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.compute.v1.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.

Example


const iterable = client.listAsync(request);
for await (const response of iterable) {
  // process response
}

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
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.compute.v1.IInstanceWithNamedPorts[], protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest \| null, protos.google.cloud.compute.v1.IInstanceGroupsListInstances ]>

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;

Parameters

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>`

Returns

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;

Parameters

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>`

Returns

Type	Description
void

listInstancesAsync(request, options)

listInstancesAsync(request?: protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.IInstanceWithNamedPorts>;

Equivalent to listInstances, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.compute.v1.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.

Example


const iterable = client.listInstancesAsync(request);
for await (const response of iterable) {
  // process response
}

listInstancesStream(request, options)

listInstancesStream(request?: protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListInstancesInstanceGroupsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [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 listInstancesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listStream(request, options)

listStream(request?: protos.google.cloud.compute.v1.IListInstanceGroupsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IListInstanceGroupsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation \| undefined, {} \| undefined ]>

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;

Parameters

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>`

Returns

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;

Parameters

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>`

Returns

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
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation \| undefined, {} \| undefined ]>

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;

Parameters

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>`

Returns

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;

Parameters

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>`

Returns

Type	Description
void