1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Compute
  7. \
  8. Resource
  9. \
  10. NodeGroups

NodeGroups

class NodeGroups extends Resource (View source)

The "nodeGroups" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $nodeGroups = $computeService->nodeGroups;

Methods

Operation
addNodes(string $project, string $zone, string $nodeGroup, NodeGroupsAddNodesRequest $postBody, array $optParams = [])

Adds specified number of nodes to the node group. (nodeGroups.addNodes)

NodeGroupAggregatedList
aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Operation
delete(string $project, string $zone, string $nodeGroup, array $optParams = [])

Deletes the specified NodeGroup resource. (nodeGroups.delete)

Operation
deleteNodes(string $project, string $zone, string $nodeGroup, NodeGroupsDeleteNodesRequest $postBody, array $optParams = [])

Deletes specified nodes from the node group. (nodeGroups.deleteNodes)

NodeGroup
get(string $project, string $zone, string $nodeGroup, array $optParams = [])

Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. (nodeGroups.get)

Policy
getIamPolicy(string $project, string $zone, string $resource, array $optParams = [])

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (nodeGroups.getIamPolicy)

Operation
insert(string $project, string $zone, int $initialNodeCount, NodeGroup $postBody, array $optParams = [])

Creates a NodeGroup resource in the specified project using the data included in the request. (nodeGroups.insert)

NodeGroupList
listNodeGroups(string $project, string $zone, array $optParams = [])

Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.

NodeGroupsListNodes
listNodes(string $project, string $zone, string $nodeGroup, array $optParams = [])

Lists nodes in the node group. (nodeGroups.listNodes)

Operation
patch(string $project, string $zone, string $nodeGroup, NodeGroup $postBody, array $optParams = [])

Updates the specified node group. (nodeGroups.patch)

Operation
performMaintenance(string $project, string $zone, string $nodeGroup, NodeGroupsPerformMaintenanceRequest $postBody, array $optParams = [])

Perform maintenance on a subset of nodes in the node group.

Policy
setIamPolicy(string $project, string $zone, string $resource, ZoneSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (nodeGroups.setIamPolicy)

Operation
setNodeTemplate(string $project, string $zone, string $nodeGroup, NodeGroupsSetNodeTemplateRequest $postBody, array $optParams = [])

Updates the node template of the node group. (nodeGroups.setNodeTemplate)

Operation
simulateMaintenanceEvent(string $project, string $zone, string $nodeGroup, NodeGroupsSimulateMaintenanceEventRequest $postBody, array $optParams = [])

Simulates maintenance event on specified nodes from the node group.

TestPermissionsResponse
testIamPermissions(string $project, string $zone, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

Details

at line 67
Operation addNodes(string $project, string $zone, string $nodeGroup, NodeGroupsAddNodesRequest $postBody, array $optParams = [])

Adds specified number of nodes to the node group. (nodeGroups.addNodes)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the NodeGroup resource.
NodeGroupsAddNodesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 148
NodeGroupAggregatedList aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

(nodeGroups.aggregatedList)

Parameters

string $project

Project ID for this request.
array $optParams

Optional parameters.

Return Value

NodeGroupAggregatedList

Exceptions

Exception

at line 175
Operation delete(string $project, string $zone, string $nodeGroup, array $optParams = [])

Deletes the specified NodeGroup resource. (nodeGroups.delete)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the NodeGroup resource to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 204
Operation deleteNodes(string $project, string $zone, string $nodeGroup, NodeGroupsDeleteNodesRequest $postBody, array $optParams = [])

Deletes specified nodes from the node group. (nodeGroups.deleteNodes)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the NodeGroup resource whose nodes will be deleted.
NodeGroupsDeleteNodesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 222
NodeGroup get(string $project, string $zone, string $nodeGroup, array $optParams = [])

Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. (nodeGroups.get)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the node group to return.
array $optParams

Optional parameters.

Return Value

NodeGroup

Exceptions

Exception

at line 241
Policy getIamPolicy(string $project, string $zone, string $resource, array $optParams = [])

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (nodeGroups.getIamPolicy)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $resource

Name or id of the resource for this request.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 270
Operation insert(string $project, string $zone, int $initialNodeCount, NodeGroup $postBody, array $optParams = [])

Creates a NodeGroup resource in the specified project using the data included in the request. (nodeGroups.insert)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
int $initialNodeCount

Initial count of nodes in the node group.
NodeGroup $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 341
NodeGroupList listNodeGroups(string $project, string $zone, array $optParams = [])

Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.

(nodeGroups.listNodeGroups)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
array $optParams

Optional parameters.

Return Value

NodeGroupList

Exceptions

Exception

at line 412
NodeGroupsListNodes listNodes(string $project, string $zone, string $nodeGroup, array $optParams = [])

Lists nodes in the node group. (nodeGroups.listNodes)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the NodeGroup resource whose nodes you want to list.
array $optParams

Optional parameters.

Return Value

NodeGroupsListNodes

Exceptions

Exception

at line 440
Operation patch(string $project, string $zone, string $nodeGroup, NodeGroup $postBody, array $optParams = [])

Updates the specified node group. (nodeGroups.patch)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the NodeGroup resource to update.
NodeGroup $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 469
Operation performMaintenance(string $project, string $zone, string $nodeGroup, NodeGroupsPerformMaintenanceRequest $postBody, array $optParams = [])

Perform maintenance on a subset of nodes in the node group.

(nodeGroups.performMaintenance)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the node group scoping this request.
NodeGroupsPerformMaintenanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 487
Policy setIamPolicy(string $project, string $zone, string $resource, ZoneSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (nodeGroups.setIamPolicy)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $resource

Name or id of the resource for this request.
ZoneSetPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 515
Operation setNodeTemplate(string $project, string $zone, string $nodeGroup, NodeGroupsSetNodeTemplateRequest $postBody, array $optParams = [])

Updates the node template of the node group. (nodeGroups.setNodeTemplate)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the NodeGroup resource to update.
NodeGroupsSetNodeTemplateRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 545
Operation simulateMaintenanceEvent(string $project, string $zone, string $nodeGroup, NodeGroupsSimulateMaintenanceEventRequest $postBody, array $optParams = [])

Simulates maintenance event on specified nodes from the node group.

(nodeGroups.simulateMaintenanceEvent)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $nodeGroup

Name of the NodeGroup resource whose nodes will go under maintenance simulation.
NodeGroupsSimulateMaintenanceEventRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 563
TestPermissionsResponse testIamPermissions(string $project, string $zone, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

(nodeGroups.testIamPermissions)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone for this request.
string $resource

Name or id of the resource for this request.
TestPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestPermissionsResponse

Exceptions

Exception