NodeGroups - Documentation

NodeGroups

google .cloud .compute .v1. NodeGroups

Represents a NodeGroups

Constructor

new NodeGroups(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

addNodes(request, callback) → {undefined}

Calls AddNodes.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddNodesNodeGroupRequest	AddNodesNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.AddNodesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls AddNodes.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddNodesNodeGroupRequest	AddNodesNodeGroupRequest 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.IAggregatedListNodeGroupsRequest	AggregatedListNodeGroupsRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.AggregatedListCallback	Node-style callback called with the error, if any, and NodeGroupAggregatedList

Returns:

Type	Description
undefined

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

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListNodeGroupsRequest	AggregatedListNodeGroupsRequest message or plain object

Returns:

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

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteNodeGroupRequest	DeleteNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.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.IDeleteNodeGroupRequest	DeleteNodeGroupRequest message or plain object

Returns:

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

deleteNodes(request, callback) → {undefined}

Calls DeleteNodes.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteNodesNodeGroupRequest	DeleteNodesNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.DeleteNodesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DeleteNodes.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteNodesNodeGroupRequest	DeleteNodesNodeGroupRequest 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.IGetNodeGroupRequest	GetNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.GetCallback	Node-style callback called with the error, if any, and NodeGroup

Returns:

Type	Description
undefined

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

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetNodeGroupRequest	GetNodeGroupRequest message or plain object

Returns:

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

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest	GetIamPolicyNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.GetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

getIamPolicy(request) → {Promise.<google.cloud.compute.v1.Policy>}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetIamPolicyNodeGroupRequest	GetIamPolicyNodeGroupRequest message or plain object

Returns:

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

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertNodeGroupRequest	InsertNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.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.IInsertNodeGroupRequest	InsertNodeGroupRequest 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.IListNodeGroupsRequest	ListNodeGroupsRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.ListCallback	Node-style callback called with the error, if any, and NodeGroupList

Returns:

Type	Description
undefined

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

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListNodeGroupsRequest	ListNodeGroupsRequest message or plain object

Returns:

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

listNodes(request, callback) → {undefined}

Calls ListNodes.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListNodesNodeGroupsRequest	ListNodesNodeGroupsRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.ListNodesCallback	Node-style callback called with the error, if any, and NodeGroupsListNodes

Returns:

Type	Description
undefined

listNodes(request) → {Promise.<google.cloud.compute.v1.NodeGroupsListNodes>}

Calls ListNodes.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListNodesNodeGroupsRequest	ListNodesNodeGroupsRequest message or plain object

Returns:

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

patch(request, callback) → {undefined}

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchNodeGroupRequest	PatchNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.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.IPatchNodeGroupRequest	PatchNodeGroupRequest message or plain object

Returns:

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

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetIamPolicyNodeGroupRequest	SetIamPolicyNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.SetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

setIamPolicy(request) → {Promise.<google.cloud.compute.v1.Policy>}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetIamPolicyNodeGroupRequest	SetIamPolicyNodeGroupRequest message or plain object

Returns:

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

setNodeTemplate(request, callback) → {undefined}

Calls SetNodeTemplate.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetNodeTemplateNodeGroupRequest	SetNodeTemplateNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.SetNodeTemplateCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SetNodeTemplate.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetNodeTemplateNodeGroupRequest	SetNodeTemplateNodeGroupRequest message or plain object

Returns:

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

simulateMaintenanceEvent(request, callback) → {undefined}

Calls SimulateMaintenanceEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISimulateMaintenanceEventNodeGroupRequest	SimulateMaintenanceEventNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.SimulateMaintenanceEventCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SimulateMaintenanceEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISimulateMaintenanceEventNodeGroupRequest	SimulateMaintenanceEventNodeGroupRequest message or plain object

Returns:

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

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ITestIamPermissionsNodeGroupRequest	TestIamPermissionsNodeGroupRequest message or plain object
`callback`	google.cloud.compute.v1.NodeGroups.TestIamPermissionsCallback	Node-style callback called with the error, if any, and TestPermissionsResponse

Returns:

Type	Description
undefined

testIamPermissions(request) → {Promise.<google.cloud.compute.v1.TestPermissionsResponse>}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ITestIamPermissionsNodeGroupRequest	TestIamPermissionsNodeGroupRequest message or plain object

Returns:

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

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

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

Type Definitions

AddNodesCallback(error, responseopt)

Callback as used by addNodes.

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

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

DeleteNodesCallback(error, responseopt)

Callback as used by deleteNodes.

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

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:

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

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

ListNodesCallback(error, responseopt)

Callback as used by listNodes.

Parameters:

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

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

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:

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

SetNodeTemplateCallback(error, responseopt)

Callback as used by setNodeTemplate.

Parameters:

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

SimulateMaintenanceEventCallback(error, responseopt)

Callback as used by simulateMaintenanceEvent.

Parameters:

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

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:

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