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

Represents a NodeGroups

Inheritance

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

Package

@google-cloud/compute

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new NodeGroups service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

addNodes(request, callback)

public addNodes(request: google.cloud.compute.v1.IAddNodesNodeGroupRequest, callback: google.cloud.compute.v1.NodeGroups.AddNodesCallback): void;

Calls AddNodes.

Parameters
Name Description
request IAddNodesNodeGroupRequest

AddNodesNodeGroupRequest message or plain object
callback AddNodesCallback

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

addNodes(request)

public addNodes(request: google.cloud.compute.v1.IAddNodesNodeGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AddNodes.

Parameter
Name Description
request IAddNodesNodeGroupRequest

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

Promise

aggregatedList(request, callback)

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

Calls AggregatedList.

Parameters
Name Description
request IAggregatedListNodeGroupsRequest

AggregatedListNodeGroupsRequest message or plain object
callback AggregatedListCallback

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

aggregatedList(request)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListNodeGroupsRequest): Promise<google.cloud.compute.v1.NodeGroupAggregatedList>;

Calls AggregatedList.

Parameter
Name Description
request IAggregatedListNodeGroupsRequest

AggregatedListNodeGroupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.NodeGroupAggregatedList>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

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

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

delete(request, callback)

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

Calls Delete.

Parameters
Name Description
request IDeleteNodeGroupRequest

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

Calls Delete.

Parameter
Name Description
request IDeleteNodeGroupRequest

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

Promise

deleteNodes(request, callback)

public deleteNodes(request: google.cloud.compute.v1.IDeleteNodesNodeGroupRequest, callback: google.cloud.compute.v1.NodeGroups.DeleteNodesCallback): void;

Calls DeleteNodes.

Parameters
Name Description
request IDeleteNodesNodeGroupRequest

DeleteNodesNodeGroupRequest message or plain object
callback DeleteNodesCallback

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

deleteNodes(request)

public deleteNodes(request: google.cloud.compute.v1.IDeleteNodesNodeGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls DeleteNodes.

Parameter
Name Description
request IDeleteNodesNodeGroupRequest

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

Promise

get(request, callback)

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

Calls Get.

Parameters
Name Description
request IGetNodeGroupRequest

GetNodeGroupRequest message or plain object
callback GetCallback

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

get(request)

public get(request: google.cloud.compute.v1.IGetNodeGroupRequest): Promise<google.cloud.compute.v1.NodeGroup>;

Calls Get.

Parameter
Name Description
request IGetNodeGroupRequest

GetNodeGroupRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.NodeGroup>

Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest, callback: google.cloud.compute.v1.NodeGroups.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
Name Description
request IGetIamPolicyNodeGroupRequest

GetIamPolicyNodeGroupRequest message or plain object
callback GetIamPolicyCallback

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

getIamPolicy(request)

public getIamPolicy(request: google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest): Promise<google.cloud.compute.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name Description
request IGetIamPolicyNodeGroupRequest

GetIamPolicyNodeGroupRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Policy>

Promise

insert(request, callback)

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

Calls Insert.

Parameters
Name Description
request IInsertNodeGroupRequest

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

Calls Insert.

Parameter
Name Description
request IInsertNodeGroupRequest

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

Promise

list(request, callback)

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

Calls List.

Parameters
Name Description
request IListNodeGroupsRequest

ListNodeGroupsRequest message or plain object
callback ListCallback

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

list(request)

public list(request: google.cloud.compute.v1.IListNodeGroupsRequest): Promise<google.cloud.compute.v1.NodeGroupList>;

Calls List.

Parameter
Name Description
request IListNodeGroupsRequest

ListNodeGroupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.NodeGroupList>

Promise

listNodes(request, callback)

public listNodes(request: google.cloud.compute.v1.IListNodesNodeGroupsRequest, callback: google.cloud.compute.v1.NodeGroups.ListNodesCallback): void;

Calls ListNodes.

Parameters
Name Description
request IListNodesNodeGroupsRequest

ListNodesNodeGroupsRequest message or plain object
callback ListNodesCallback

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

listNodes(request)

public listNodes(request: google.cloud.compute.v1.IListNodesNodeGroupsRequest): Promise<google.cloud.compute.v1.NodeGroupsListNodes>;

Calls ListNodes.

Parameter
Name Description
request IListNodesNodeGroupsRequest

ListNodesNodeGroupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.NodeGroupsListNodes>

Promise

patch(request, callback)

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

Calls Patch.

Parameters
Name Description
request IPatchNodeGroupRequest

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

Calls Patch.

Parameter
Name Description
request IPatchNodeGroupRequest

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

Promise

performMaintenance(request, callback)

public performMaintenance(request: google.cloud.compute.v1.IPerformMaintenanceNodeGroupRequest, callback: google.cloud.compute.v1.NodeGroups.PerformMaintenanceCallback): void;

Calls PerformMaintenance.

Parameters
Name Description
request IPerformMaintenanceNodeGroupRequest

PerformMaintenanceNodeGroupRequest message or plain object
callback PerformMaintenanceCallback

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

performMaintenance(request)

public performMaintenance(request: google.cloud.compute.v1.IPerformMaintenanceNodeGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls PerformMaintenance.

Parameter
Name Description
request IPerformMaintenanceNodeGroupRequest

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

Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.cloud.compute.v1.ISetIamPolicyNodeGroupRequest, callback: google.cloud.compute.v1.NodeGroups.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
Name Description
request ISetIamPolicyNodeGroupRequest

SetIamPolicyNodeGroupRequest message or plain object
callback SetIamPolicyCallback

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

setIamPolicy(request)

public setIamPolicy(request: google.cloud.compute.v1.ISetIamPolicyNodeGroupRequest): Promise<google.cloud.compute.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name Description
request ISetIamPolicyNodeGroupRequest

SetIamPolicyNodeGroupRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Policy>

Promise

setNodeTemplate(request, callback)

public setNodeTemplate(request: google.cloud.compute.v1.ISetNodeTemplateNodeGroupRequest, callback: google.cloud.compute.v1.NodeGroups.SetNodeTemplateCallback): void;

Calls SetNodeTemplate.

Parameters
Name Description
request ISetNodeTemplateNodeGroupRequest

SetNodeTemplateNodeGroupRequest message or plain object
callback SetNodeTemplateCallback

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

setNodeTemplate(request)

public setNodeTemplate(request: google.cloud.compute.v1.ISetNodeTemplateNodeGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetNodeTemplate.

Parameter
Name Description
request ISetNodeTemplateNodeGroupRequest

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

Promise

simulateMaintenanceEvent(request, callback)

public simulateMaintenanceEvent(request: google.cloud.compute.v1.ISimulateMaintenanceEventNodeGroupRequest, callback: google.cloud.compute.v1.NodeGroups.SimulateMaintenanceEventCallback): void;

Calls SimulateMaintenanceEvent.

Parameters
Name Description
request ISimulateMaintenanceEventNodeGroupRequest

SimulateMaintenanceEventNodeGroupRequest message or plain object
callback SimulateMaintenanceEventCallback

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

simulateMaintenanceEvent(request)

public simulateMaintenanceEvent(request: google.cloud.compute.v1.ISimulateMaintenanceEventNodeGroupRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SimulateMaintenanceEvent.

Parameter
Name Description
request ISimulateMaintenanceEventNodeGroupRequest

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

Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.cloud.compute.v1.ITestIamPermissionsNodeGroupRequest, callback: google.cloud.compute.v1.NodeGroups.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Name Description
request ITestIamPermissionsNodeGroupRequest

TestIamPermissionsNodeGroupRequest message or plain object
callback TestIamPermissionsCallback

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

testIamPermissions(request)

public testIamPermissions(request: google.cloud.compute.v1.ITestIamPermissionsNodeGroupRequest): Promise<google.cloud.compute.v1.TestPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name Description
request ITestIamPermissionsNodeGroupRequest

TestIamPermissionsNodeGroupRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.TestPermissionsResponse>

Promise