InstanceGroupManagers

google .cloud .compute .v1. InstanceGroupManagers

Represents an InstanceGroupManagers

Constructor

new InstanceGroupManagers(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new InstanceGroupManagers service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

abandonInstances(request, callback) → {undefined}

Calls AbandonInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAbandonInstancesInstanceGroupManagerRequest	AbandonInstancesInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.AbandonInstancesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

abandonInstances(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls AbandonInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAbandonInstancesInstanceGroupManagerRequest	AbandonInstancesInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

aggregatedList(request, callback) → {undefined}

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListInstanceGroupManagersRequest	AggregatedListInstanceGroupManagersRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.AggregatedListCallback	Node-style callback called with the error, if any, and InstanceGroupManagerAggregatedList

Returns:

Type	Description
undefined

aggregatedList(request) → {Promise.<google.cloud.compute.v1.InstanceGroupManagerAggregatedList>}

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListInstanceGroupManagersRequest	AggregatedListInstanceGroupManagersRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.InstanceGroupManagerAggregatedList>	Promise

applyUpdatesToInstances(request, callback) → {undefined}

Calls ApplyUpdatesToInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IApplyUpdatesToInstancesInstanceGroupManagerRequest	ApplyUpdatesToInstancesInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.ApplyUpdatesToInstancesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

applyUpdatesToInstances(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls ApplyUpdatesToInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IApplyUpdatesToInstancesInstanceGroupManagerRequest	ApplyUpdatesToInstancesInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

createInstances(request, callback) → {undefined}

Calls CreateInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ICreateInstancesInstanceGroupManagerRequest	CreateInstancesInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.CreateInstancesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createInstances(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls CreateInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ICreateInstancesInstanceGroupManagerRequest	CreateInstancesInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteInstanceGroupManagerRequest	DeleteInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.DeleteCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

delete(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteInstanceGroupManagerRequest	DeleteInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

deleteInstances(request, callback) → {undefined}

Calls DeleteInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteInstancesInstanceGroupManagerRequest	DeleteInstancesInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.DeleteInstancesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteInstances(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls DeleteInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteInstancesInstanceGroupManagerRequest	DeleteInstancesInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

deletePerInstanceConfigs(request, callback) → {undefined}

Calls DeletePerInstanceConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeletePerInstanceConfigsInstanceGroupManagerRequest	DeletePerInstanceConfigsInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.DeletePerInstanceConfigsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deletePerInstanceConfigs(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls DeletePerInstanceConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeletePerInstanceConfigsInstanceGroupManagerRequest	DeletePerInstanceConfigsInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

get(request, callback) → {undefined}

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetInstanceGroupManagerRequest	GetInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.GetCallback	Node-style callback called with the error, if any, and InstanceGroupManager

Returns:

Type	Description
undefined

get(request) → {Promise.<google.cloud.compute.v1.InstanceGroupManager>}

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetInstanceGroupManagerRequest	GetInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.InstanceGroupManager>	Promise

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertInstanceGroupManagerRequest	InsertInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.InsertCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

insert(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertInstanceGroupManagerRequest	InsertInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

list(request, callback) → {undefined}

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListInstanceGroupManagersRequest	ListInstanceGroupManagersRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.ListCallback	Node-style callback called with the error, if any, and InstanceGroupManagerList

Returns:

Type	Description
undefined

list(request) → {Promise.<google.cloud.compute.v1.InstanceGroupManagerList>}

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListInstanceGroupManagersRequest	ListInstanceGroupManagersRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.InstanceGroupManagerList>	Promise

listErrors(request, callback) → {undefined}

Calls ListErrors.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListErrorsInstanceGroupManagersRequest	ListErrorsInstanceGroupManagersRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.ListErrorsCallback	Node-style callback called with the error, if any, and InstanceGroupManagersListErrorsResponse

Returns:

Type	Description
undefined

listErrors(request) → {Promise.<google.cloud.compute.v1.InstanceGroupManagersListErrorsResponse>}

Calls ListErrors.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListErrorsInstanceGroupManagersRequest	ListErrorsInstanceGroupManagersRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.InstanceGroupManagersListErrorsResponse>	Promise

listManagedInstances(request, callback) → {undefined}

Calls ListManagedInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListManagedInstancesInstanceGroupManagersRequest	ListManagedInstancesInstanceGroupManagersRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.ListManagedInstancesCallback	Node-style callback called with the error, if any, and InstanceGroupManagersListManagedInstancesResponse

Returns:

Type	Description
undefined

listManagedInstances(request) → {Promise.<google.cloud.compute.v1.InstanceGroupManagersListManagedInstancesResponse>}

Calls ListManagedInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListManagedInstancesInstanceGroupManagersRequest	ListManagedInstancesInstanceGroupManagersRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.InstanceGroupManagersListManagedInstancesResponse>	Promise

listPerInstanceConfigs(request, callback) → {undefined}

Calls ListPerInstanceConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListPerInstanceConfigsInstanceGroupManagersRequest	ListPerInstanceConfigsInstanceGroupManagersRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.ListPerInstanceConfigsCallback	Node-style callback called with the error, if any, and InstanceGroupManagersListPerInstanceConfigsResp

Returns:

Type	Description
undefined

listPerInstanceConfigs(request) → {Promise.<google.cloud.compute.v1.InstanceGroupManagersListPerInstanceConfigsResp>}

Calls ListPerInstanceConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListPerInstanceConfigsInstanceGroupManagersRequest	ListPerInstanceConfigsInstanceGroupManagersRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.InstanceGroupManagersListPerInstanceConfigsResp>	Promise

patch(request, callback) → {undefined}

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchInstanceGroupManagerRequest	PatchInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.PatchCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

patch(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchInstanceGroupManagerRequest	PatchInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

patchPerInstanceConfigs(request, callback) → {undefined}

Calls PatchPerInstanceConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchPerInstanceConfigsInstanceGroupManagerRequest	PatchPerInstanceConfigsInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.PatchPerInstanceConfigsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

patchPerInstanceConfigs(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls PatchPerInstanceConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchPerInstanceConfigsInstanceGroupManagerRequest	PatchPerInstanceConfigsInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

recreateInstances(request, callback) → {undefined}

Calls RecreateInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRecreateInstancesInstanceGroupManagerRequest	RecreateInstancesInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.RecreateInstancesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

recreateInstances(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls RecreateInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRecreateInstancesInstanceGroupManagerRequest	RecreateInstancesInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

resize(request, callback) → {undefined}

Calls Resize.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IResizeInstanceGroupManagerRequest	ResizeInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.ResizeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

resize(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Resize.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IResizeInstanceGroupManagerRequest	ResizeInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

setInstanceTemplate(request, callback) → {undefined}

Calls SetInstanceTemplate.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetInstanceTemplateInstanceGroupManagerRequest	SetInstanceTemplateInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.SetInstanceTemplateCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setInstanceTemplate(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls SetInstanceTemplate.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetInstanceTemplateInstanceGroupManagerRequest	SetInstanceTemplateInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

setTargetPools(request, callback) → {undefined}

Calls SetTargetPools.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetTargetPoolsInstanceGroupManagerRequest	SetTargetPoolsInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.SetTargetPoolsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setTargetPools(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls SetTargetPools.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetTargetPoolsInstanceGroupManagerRequest	SetTargetPoolsInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

updatePerInstanceConfigs(request, callback) → {undefined}

Calls UpdatePerInstanceConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IUpdatePerInstanceConfigsInstanceGroupManagerRequest	UpdatePerInstanceConfigsInstanceGroupManagerRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroupManagers.UpdatePerInstanceConfigsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updatePerInstanceConfigs(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls UpdatePerInstanceConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IUpdatePerInstanceConfigsInstanceGroupManagerRequest	UpdatePerInstanceConfigsInstanceGroupManagerRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {InstanceGroupManagers}

Creates new InstanceGroupManagers service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

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

Type Definitions

AbandonInstancesCallback(error, responseopt)

Callback as used by abandonInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

AggregatedListCallback(error, responseopt)

Callback as used by aggregatedList.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.InstanceGroupManagerAggregatedList	<optional>	InstanceGroupManagerAggregatedList

ApplyUpdatesToInstancesCallback(error, responseopt)

Callback as used by applyUpdatesToInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

CreateInstancesCallback(error, responseopt)

Callback as used by createInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

DeleteCallback(error, responseopt)

Callback as used by delete_.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

DeleteInstancesCallback(error, responseopt)

Callback as used by deleteInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

DeletePerInstanceConfigsCallback(error, responseopt)

Callback as used by deletePerInstanceConfigs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

GetCallback(error, responseopt)

Callback as used by get.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.InstanceGroupManager	<optional>	InstanceGroupManager

InsertCallback(error, responseopt)

Callback as used by insert.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

ListCallback(error, responseopt)

Callback as used by list.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.InstanceGroupManagerList	<optional>	InstanceGroupManagerList

ListErrorsCallback(error, responseopt)

Callback as used by listErrors.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.InstanceGroupManagersListErrorsResponse	<optional>	InstanceGroupManagersListErrorsResponse

ListManagedInstancesCallback(error, responseopt)

Callback as used by listManagedInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.InstanceGroupManagersListManagedInstancesResponse	<optional>	InstanceGroupManagersListManagedInstancesResponse

ListPerInstanceConfigsCallback(error, responseopt)

Callback as used by listPerInstanceConfigs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.InstanceGroupManagersListPerInstanceConfigsResp	<optional>	InstanceGroupManagersListPerInstanceConfigsResp

PatchCallback(error, responseopt)

Callback as used by patch.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

PatchPerInstanceConfigsCallback(error, responseopt)

Callback as used by patchPerInstanceConfigs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

RecreateInstancesCallback(error, responseopt)

Callback as used by recreateInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

ResizeCallback(error, responseopt)

Callback as used by resize.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

SetInstanceTemplateCallback(error, responseopt)

Callback as used by setInstanceTemplate.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

SetTargetPoolsCallback(error, responseopt)

Callback as used by setTargetPools.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

UpdatePerInstanceConfigsCallback(error, responseopt)

Callback as used by updatePerInstanceConfigs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation