Class protos.google.cloud.compute.v1.InstanceGroupManagers (4.5.0)

Represents an InstanceGroupManagers

Inheritance

$protobuf.rpc.Service > protos.google.cloud.compute.v1.InstanceGroupManagers

Package

@google-cloud/compute

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new InstanceGroupManagers service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

abandonInstances(request, callback)

public abandonInstances(request: google.cloud.compute.v1.IAbandonInstancesInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.AbandonInstancesCallback): void;

Calls AbandonInstances.

Parameters
Name Description
request IAbandonInstancesInstanceGroupManagerRequest

AbandonInstancesInstanceGroupManagerRequest message or plain object
callback AbandonInstancesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

abandonInstances(request)

public abandonInstances(request: google.cloud.compute.v1.IAbandonInstancesInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AbandonInstances.

Parameter
Name Description
request IAbandonInstancesInstanceGroupManagerRequest

AbandonInstancesInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

aggregatedList(request, callback)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListInstanceGroupManagersRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.AggregatedListCallback): void;

Calls AggregatedList.

Parameters
Name Description
request IAggregatedListInstanceGroupManagersRequest

AggregatedListInstanceGroupManagersRequest message or plain object
callback AggregatedListCallback

Node-style callback called with the error, if any, and InstanceGroupManagerAggregatedList
Returns
Type Description
void

aggregatedList(request)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListInstanceGroupManagersRequest): Promise<google.cloud.compute.v1.InstanceGroupManagerAggregatedList>;

Calls AggregatedList.

Parameter
Name Description
request IAggregatedListInstanceGroupManagersRequest

AggregatedListInstanceGroupManagersRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupManagerAggregatedList>

Promise

applyUpdatesToInstances(request, callback)

public applyUpdatesToInstances(request: google.cloud.compute.v1.IApplyUpdatesToInstancesInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.ApplyUpdatesToInstancesCallback): void;

Calls ApplyUpdatesToInstances.

Parameters
Name Description
request IApplyUpdatesToInstancesInstanceGroupManagerRequest

ApplyUpdatesToInstancesInstanceGroupManagerRequest message or plain object
callback ApplyUpdatesToInstancesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

applyUpdatesToInstances(request)

public applyUpdatesToInstances(request: google.cloud.compute.v1.IApplyUpdatesToInstancesInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls ApplyUpdatesToInstances.

Parameter
Name Description
request IApplyUpdatesToInstancesInstanceGroupManagerRequest

ApplyUpdatesToInstancesInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): InstanceGroupManagers;

Creates new InstanceGroupManagers service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
InstanceGroupManagers

RPC service. Useful where requests and/or responses are streamed.

createInstances(request, callback)

public createInstances(request: google.cloud.compute.v1.ICreateInstancesInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.CreateInstancesCallback): void;

Calls CreateInstances.

Parameters
Name Description
request ICreateInstancesInstanceGroupManagerRequest

CreateInstancesInstanceGroupManagerRequest message or plain object
callback CreateInstancesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createInstances(request)

public createInstances(request: google.cloud.compute.v1.ICreateInstancesInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls CreateInstances.

Parameter
Name Description
request ICreateInstancesInstanceGroupManagerRequest

CreateInstancesInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

delete(request, callback)

public delete(request: google.cloud.compute.v1.IDeleteInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.DeleteCallback): void;

Calls Delete.

Parameters
Name Description
request IDeleteInstanceGroupManagerRequest

DeleteInstanceGroupManagerRequest message or plain object
callback DeleteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

delete(request)

public delete(request: google.cloud.compute.v1.IDeleteInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Delete.

Parameter
Name Description
request IDeleteInstanceGroupManagerRequest

DeleteInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

deleteInstances(request, callback)

public deleteInstances(request: google.cloud.compute.v1.IDeleteInstancesInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.DeleteInstancesCallback): void;

Calls DeleteInstances.

Parameters
Name Description
request IDeleteInstancesInstanceGroupManagerRequest

DeleteInstancesInstanceGroupManagerRequest message or plain object
callback DeleteInstancesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteInstances(request)

public deleteInstances(request: google.cloud.compute.v1.IDeleteInstancesInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls DeleteInstances.

Parameter
Name Description
request IDeleteInstancesInstanceGroupManagerRequest

DeleteInstancesInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

deletePerInstanceConfigs(request, callback)

public deletePerInstanceConfigs(request: google.cloud.compute.v1.IDeletePerInstanceConfigsInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.DeletePerInstanceConfigsCallback): void;

Calls DeletePerInstanceConfigs.

Parameters
Name Description
request IDeletePerInstanceConfigsInstanceGroupManagerRequest

DeletePerInstanceConfigsInstanceGroupManagerRequest message or plain object
callback DeletePerInstanceConfigsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deletePerInstanceConfigs(request)

public deletePerInstanceConfigs(request: google.cloud.compute.v1.IDeletePerInstanceConfigsInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls DeletePerInstanceConfigs.

Parameter
Name Description
request IDeletePerInstanceConfigsInstanceGroupManagerRequest

DeletePerInstanceConfigsInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

get(request, callback)

public get(request: google.cloud.compute.v1.IGetInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.GetCallback): void;

Calls Get.

Parameters
Name Description
request IGetInstanceGroupManagerRequest

GetInstanceGroupManagerRequest message or plain object
callback GetCallback

Node-style callback called with the error, if any, and InstanceGroupManager
Returns
Type Description
void

get(request)

public get(request: google.cloud.compute.v1.IGetInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.InstanceGroupManager>;

Calls Get.

Parameter
Name Description
request IGetInstanceGroupManagerRequest

GetInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupManager>

Promise

insert(request, callback)

public insert(request: google.cloud.compute.v1.IInsertInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.InsertCallback): void;

Calls Insert.

Parameters
Name Description
request IInsertInstanceGroupManagerRequest

InsertInstanceGroupManagerRequest message or plain object
callback InsertCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

insert(request)

public insert(request: google.cloud.compute.v1.IInsertInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Insert.

Parameter
Name Description
request IInsertInstanceGroupManagerRequest

InsertInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

list(request, callback)

public list(request: google.cloud.compute.v1.IListInstanceGroupManagersRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.ListCallback): void;

Calls List.

Parameters
Name Description
request IListInstanceGroupManagersRequest

ListInstanceGroupManagersRequest message or plain object
callback ListCallback

Node-style callback called with the error, if any, and InstanceGroupManagerList
Returns
Type Description
void

list(request)

public list(request: google.cloud.compute.v1.IListInstanceGroupManagersRequest): Promise<google.cloud.compute.v1.InstanceGroupManagerList>;

Calls List.

Parameter
Name Description
request IListInstanceGroupManagersRequest

ListInstanceGroupManagersRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupManagerList>

Promise

listErrors(request, callback)

public listErrors(request: google.cloud.compute.v1.IListErrorsInstanceGroupManagersRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.ListErrorsCallback): void;

Calls ListErrors.

Parameters
Name Description
request IListErrorsInstanceGroupManagersRequest

ListErrorsInstanceGroupManagersRequest message or plain object
callback ListErrorsCallback

Node-style callback called with the error, if any, and InstanceGroupManagersListErrorsResponse
Returns
Type Description
void

listErrors(request)

public listErrors(request: google.cloud.compute.v1.IListErrorsInstanceGroupManagersRequest): Promise<google.cloud.compute.v1.InstanceGroupManagersListErrorsResponse>;

Calls ListErrors.

Parameter
Name Description
request IListErrorsInstanceGroupManagersRequest

ListErrorsInstanceGroupManagersRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupManagersListErrorsResponse>

Promise

listManagedInstances(request, callback)

public listManagedInstances(request: google.cloud.compute.v1.IListManagedInstancesInstanceGroupManagersRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.ListManagedInstancesCallback): void;

Calls ListManagedInstances.

Parameters
Name Description
request IListManagedInstancesInstanceGroupManagersRequest

ListManagedInstancesInstanceGroupManagersRequest message or plain object
callback ListManagedInstancesCallback

Node-style callback called with the error, if any, and InstanceGroupManagersListManagedInstancesResponse
Returns
Type Description
void

listManagedInstances(request)

public listManagedInstances(request: google.cloud.compute.v1.IListManagedInstancesInstanceGroupManagersRequest): Promise<google.cloud.compute.v1.InstanceGroupManagersListManagedInstancesResponse>;

Calls ListManagedInstances.

Parameter
Name Description
request IListManagedInstancesInstanceGroupManagersRequest

ListManagedInstancesInstanceGroupManagersRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupManagersListManagedInstancesResponse>

Promise

listPerInstanceConfigs(request, callback)

public listPerInstanceConfigs(request: google.cloud.compute.v1.IListPerInstanceConfigsInstanceGroupManagersRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.ListPerInstanceConfigsCallback): void;

Calls ListPerInstanceConfigs.

Parameters
Name Description
request IListPerInstanceConfigsInstanceGroupManagersRequest

ListPerInstanceConfigsInstanceGroupManagersRequest message or plain object
callback ListPerInstanceConfigsCallback

Node-style callback called with the error, if any, and InstanceGroupManagersListPerInstanceConfigsResp
Returns
Type Description
void

listPerInstanceConfigs(request)

public listPerInstanceConfigs(request: google.cloud.compute.v1.IListPerInstanceConfigsInstanceGroupManagersRequest): Promise<google.cloud.compute.v1.InstanceGroupManagersListPerInstanceConfigsResp>;

Calls ListPerInstanceConfigs.

Parameter
Name Description
request IListPerInstanceConfigsInstanceGroupManagersRequest

ListPerInstanceConfigsInstanceGroupManagersRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupManagersListPerInstanceConfigsResp>

Promise

patch(request, callback)

public patch(request: google.cloud.compute.v1.IPatchInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.PatchCallback): void;

Calls Patch.

Parameters
Name Description
request IPatchInstanceGroupManagerRequest

PatchInstanceGroupManagerRequest message or plain object
callback PatchCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

patch(request)

public patch(request: google.cloud.compute.v1.IPatchInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Patch.

Parameter
Name Description
request IPatchInstanceGroupManagerRequest

PatchInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

patchPerInstanceConfigs(request, callback)

public patchPerInstanceConfigs(request: google.cloud.compute.v1.IPatchPerInstanceConfigsInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.PatchPerInstanceConfigsCallback): void;

Calls PatchPerInstanceConfigs.

Parameters
Name Description
request IPatchPerInstanceConfigsInstanceGroupManagerRequest

PatchPerInstanceConfigsInstanceGroupManagerRequest message or plain object
callback PatchPerInstanceConfigsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

patchPerInstanceConfigs(request)

public patchPerInstanceConfigs(request: google.cloud.compute.v1.IPatchPerInstanceConfigsInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls PatchPerInstanceConfigs.

Parameter
Name Description
request IPatchPerInstanceConfigsInstanceGroupManagerRequest

PatchPerInstanceConfigsInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

recreateInstances(request, callback)

public recreateInstances(request: google.cloud.compute.v1.IRecreateInstancesInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.RecreateInstancesCallback): void;

Calls RecreateInstances.

Parameters
Name Description
request IRecreateInstancesInstanceGroupManagerRequest

RecreateInstancesInstanceGroupManagerRequest message or plain object
callback RecreateInstancesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

recreateInstances(request)

public recreateInstances(request: google.cloud.compute.v1.IRecreateInstancesInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls RecreateInstances.

Parameter
Name Description
request IRecreateInstancesInstanceGroupManagerRequest

RecreateInstancesInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

resize(request, callback)

public resize(request: google.cloud.compute.v1.IResizeInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.ResizeCallback): void;

Calls Resize.

Parameters
Name Description
request IResizeInstanceGroupManagerRequest

ResizeInstanceGroupManagerRequest message or plain object
callback ResizeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

resize(request)

public resize(request: google.cloud.compute.v1.IResizeInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Resize.

Parameter
Name Description
request IResizeInstanceGroupManagerRequest

ResizeInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setInstanceTemplate(request, callback)

public setInstanceTemplate(request: google.cloud.compute.v1.ISetInstanceTemplateInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.SetInstanceTemplateCallback): void;

Calls SetInstanceTemplate.

Parameters
Name Description
request ISetInstanceTemplateInstanceGroupManagerRequest

SetInstanceTemplateInstanceGroupManagerRequest message or plain object
callback SetInstanceTemplateCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setInstanceTemplate(request)

public setInstanceTemplate(request: google.cloud.compute.v1.ISetInstanceTemplateInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetInstanceTemplate.

Parameter
Name Description
request ISetInstanceTemplateInstanceGroupManagerRequest

SetInstanceTemplateInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setTargetPools(request, callback)

public setTargetPools(request: google.cloud.compute.v1.ISetTargetPoolsInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.SetTargetPoolsCallback): void;

Calls SetTargetPools.

Parameters
Name Description
request ISetTargetPoolsInstanceGroupManagerRequest

SetTargetPoolsInstanceGroupManagerRequest message or plain object
callback SetTargetPoolsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setTargetPools(request)

public setTargetPools(request: google.cloud.compute.v1.ISetTargetPoolsInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetTargetPools.

Parameter
Name Description
request ISetTargetPoolsInstanceGroupManagerRequest

SetTargetPoolsInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

updatePerInstanceConfigs(request, callback)

public updatePerInstanceConfigs(request: google.cloud.compute.v1.IUpdatePerInstanceConfigsInstanceGroupManagerRequest, callback: google.cloud.compute.v1.InstanceGroupManagers.UpdatePerInstanceConfigsCallback): void;

Calls UpdatePerInstanceConfigs.

Parameters
Name Description
request IUpdatePerInstanceConfigsInstanceGroupManagerRequest

UpdatePerInstanceConfigsInstanceGroupManagerRequest message or plain object
callback UpdatePerInstanceConfigsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updatePerInstanceConfigs(request)

public updatePerInstanceConfigs(request: google.cloud.compute.v1.IUpdatePerInstanceConfigsInstanceGroupManagerRequest): Promise<google.cloud.compute.v1.Operation>;

Calls UpdatePerInstanceConfigs.

Parameter
Name Description
request IUpdatePerInstanceConfigsInstanceGroupManagerRequest

UpdatePerInstanceConfigsInstanceGroupManagerRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise