InstanceGroups

google .cloud .compute .v1. InstanceGroups

Represents an InstanceGroups

Constructor

new InstanceGroups(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new InstanceGroups 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

addInstances(request, callback) → {undefined}

Calls AddInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddInstancesInstanceGroupRequest	AddInstancesInstanceGroupRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.AddInstancesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls AddInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddInstancesInstanceGroupRequest	AddInstancesInstanceGroupRequest 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.IAggregatedListInstanceGroupsRequest	AggregatedListInstanceGroupsRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.AggregatedListCallback	Node-style callback called with the error, if any, and InstanceGroupAggregatedList

Returns:

Type	Description
undefined

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

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListInstanceGroupsRequest	AggregatedListInstanceGroupsRequest message or plain object

Returns:

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

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteInstanceGroupRequest	DeleteInstanceGroupRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.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.IDeleteInstanceGroupRequest	DeleteInstanceGroupRequest 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.IGetInstanceGroupRequest	GetInstanceGroupRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.GetCallback	Node-style callback called with the error, if any, and InstanceGroup

Returns:

Type	Description
undefined

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

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetInstanceGroupRequest	GetInstanceGroupRequest message or plain object

Returns:

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

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertInstanceGroupRequest	InsertInstanceGroupRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.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.IInsertInstanceGroupRequest	InsertInstanceGroupRequest 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.IListInstanceGroupsRequest	ListInstanceGroupsRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.ListCallback	Node-style callback called with the error, if any, and InstanceGroupList

Returns:

Type	Description
undefined

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

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListInstanceGroupsRequest	ListInstanceGroupsRequest message or plain object

Returns:

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

listInstances(request, callback) → {undefined}

Calls ListInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListInstancesInstanceGroupsRequest	ListInstancesInstanceGroupsRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.ListInstancesCallback	Node-style callback called with the error, if any, and InstanceGroupsListInstances

Returns:

Type	Description
undefined

listInstances(request) → {Promise.<google.cloud.compute.v1.InstanceGroupsListInstances>}

Calls ListInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListInstancesInstanceGroupsRequest	ListInstancesInstanceGroupsRequest message or plain object

Returns:

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

removeInstances(request, callback) → {undefined}

Calls RemoveInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest	RemoveInstancesInstanceGroupRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.RemoveInstancesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls RemoveInstances.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest	RemoveInstancesInstanceGroupRequest message or plain object

Returns:

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

setNamedPorts(request, callback) → {undefined}

Calls SetNamedPorts.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest	SetNamedPortsInstanceGroupRequest message or plain object
`callback`	google.cloud.compute.v1.InstanceGroups.SetNamedPortsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SetNamedPorts.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest	SetNamedPortsInstanceGroupRequest message or plain object

Returns:

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

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

Creates new InstanceGroups 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
InstanceGroups	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AddInstancesCallback(error, responseopt)

Callback as used by addInstances.

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.InstanceGroupAggregatedList	<optional>	InstanceGroupAggregatedList

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

GetCallback(error, responseopt)

Callback as used by get.

Parameters:

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

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.InstanceGroupList	<optional>	InstanceGroupList

ListInstancesCallback(error, responseopt)

Callback as used by listInstances.

Parameters:

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

RemoveInstancesCallback(error, responseopt)

Callback as used by removeInstances.

Parameters:

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

SetNamedPortsCallback(error, responseopt)

Callback as used by setNamedPorts.

Parameters:

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