Class protos.google.cloud.compute.v1.InstanceGroups (4.3.0)

Represents an InstanceGroups

Inheritance

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

Package

@google-cloud/compute

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new InstanceGroups service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

addInstances(request, callback)

public addInstances(request: google.cloud.compute.v1.IAddInstancesInstanceGroupRequest, callback: google.cloud.compute.v1.InstanceGroups.AddInstancesCallback): void;

Calls AddInstances.

Parameters
Name Description
request IAddInstancesInstanceGroupRequest

AddInstancesInstanceGroupRequest message or plain object
callback AddInstancesCallback

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

addInstances(request)

public addInstances(request: google.cloud.compute.v1.IAddInstancesInstanceGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AddInstances.

Parameter
Name Description
request IAddInstancesInstanceGroupRequest

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

Promise

aggregatedList(request, callback)

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

Calls AggregatedList.

Parameters
Name Description
request IAggregatedListInstanceGroupsRequest

AggregatedListInstanceGroupsRequest message or plain object
callback AggregatedListCallback

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

aggregatedList(request)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListInstanceGroupsRequest): Promise<google.cloud.compute.v1.InstanceGroupAggregatedList>;

Calls AggregatedList.

Parameter
Name Description
request IAggregatedListInstanceGroupsRequest

AggregatedListInstanceGroupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupAggregatedList>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new InstanceGroups 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
InstanceGroups

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

delete(request, callback)

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

Calls Delete.

Parameters
Name Description
request IDeleteInstanceGroupRequest

DeleteInstanceGroupRequest 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.IDeleteInstanceGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Delete.

Parameter
Name Description
request IDeleteInstanceGroupRequest

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

Promise

get(request, callback)

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

Calls Get.

Parameters
Name Description
request IGetInstanceGroupRequest

GetInstanceGroupRequest message or plain object
callback GetCallback

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

get(request)

public get(request: google.cloud.compute.v1.IGetInstanceGroupRequest): Promise<google.cloud.compute.v1.InstanceGroup>;

Calls Get.

Parameter
Name Description
request IGetInstanceGroupRequest

GetInstanceGroupRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroup>

Promise

insert(request, callback)

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

Calls Insert.

Parameters
Name Description
request IInsertInstanceGroupRequest

InsertInstanceGroupRequest 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.IInsertInstanceGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Insert.

Parameter
Name Description
request IInsertInstanceGroupRequest

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

Promise

list(request, callback)

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

Calls List.

Parameters
Name Description
request IListInstanceGroupsRequest

ListInstanceGroupsRequest message or plain object
callback ListCallback

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

list(request)

public list(request: google.cloud.compute.v1.IListInstanceGroupsRequest): Promise<google.cloud.compute.v1.InstanceGroupList>;

Calls List.

Parameter
Name Description
request IListInstanceGroupsRequest

ListInstanceGroupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupList>

Promise

listInstances(request, callback)

public listInstances(request: google.cloud.compute.v1.IListInstancesInstanceGroupsRequest, callback: google.cloud.compute.v1.InstanceGroups.ListInstancesCallback): void;

Calls ListInstances.

Parameters
Name Description
request IListInstancesInstanceGroupsRequest

ListInstancesInstanceGroupsRequest message or plain object
callback ListInstancesCallback

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

listInstances(request)

public listInstances(request: google.cloud.compute.v1.IListInstancesInstanceGroupsRequest): Promise<google.cloud.compute.v1.InstanceGroupsListInstances>;

Calls ListInstances.

Parameter
Name Description
request IListInstancesInstanceGroupsRequest

ListInstancesInstanceGroupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.InstanceGroupsListInstances>

Promise

removeInstances(request, callback)

public removeInstances(request: google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest, callback: google.cloud.compute.v1.InstanceGroups.RemoveInstancesCallback): void;

Calls RemoveInstances.

Parameters
Name Description
request IRemoveInstancesInstanceGroupRequest

RemoveInstancesInstanceGroupRequest message or plain object
callback RemoveInstancesCallback

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

removeInstances(request)

public removeInstances(request: google.cloud.compute.v1.IRemoveInstancesInstanceGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls RemoveInstances.

Parameter
Name Description
request IRemoveInstancesInstanceGroupRequest

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

Promise

setNamedPorts(request, callback)

public setNamedPorts(request: google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest, callback: google.cloud.compute.v1.InstanceGroups.SetNamedPortsCallback): void;

Calls SetNamedPorts.

Parameters
Name Description
request ISetNamedPortsInstanceGroupRequest

SetNamedPortsInstanceGroupRequest message or plain object
callback SetNamedPortsCallback

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

setNamedPorts(request)

public setNamedPorts(request: google.cloud.compute.v1.ISetNamedPortsInstanceGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetNamedPorts.

Parameter
Name Description
request ISetNamedPortsInstanceGroupRequest

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

Promise