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

ProjectsLocationsClustersNodePools

class ProjectsLocationsClustersNodePools extends Resource (View source)

The "nodePools" collection of methods.

Typical usage is:

 $containerService = new Google\Service\Container(...);
 $nodePools = $containerService->projects_locations_clusters_nodePools;

Methods

ContainerEmpty
completeUpgrade(string $name, CompleteNodePoolUpgradeRequest $postBody, array $optParams = [])

CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete. (nodePools.completeUpgrade)

Operation
create(string $parent, CreateNodePoolRequest $postBody, array $optParams = [])

Creates a node pool for a cluster. (nodePools.create)

Operation
delete(string $name, array $optParams = [])

Deletes a node pool from a cluster. (nodePools.delete)

NodePool
get(string $name, array $optParams = [])

Retrieves the requested node pool. (nodePools.get)

ListNodePoolsResponse
listProjectsLocationsClustersNodePools(string $parent, array $optParams = [])

Lists the node pools for a cluster.

Operation
rollback(string $name, RollbackNodePoolUpgradeRequest $postBody, array $optParams = [])

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. (nodePools.rollback)

Operation
setAutoscaling(string $name, SetNodePoolAutoscalingRequest $postBody, array $optParams = [])

Sets the autoscaling settings for the specified node pool.

Operation
setManagement(string $name, SetNodePoolManagementRequest $postBody, array $optParams = [])

Sets the NodeManagement options for a node pool. (nodePools.setManagement)

Operation
setSize(string $name, SetNodePoolSizeRequest $postBody, array $optParams = [])

Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

Operation
update(string $name, UpdateNodePoolRequest $postBody, array $optParams = [])

Updates the version and/or image type for the specified node pool.

Details

at line 54
ContainerEmpty completeUpgrade(string $name, CompleteNodePoolUpgradeRequest $postBody, array $optParams = [])

CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete. (nodePools.completeUpgrade)

Parameters

string $name

The name (project, location, cluster, node pool id) of the node pool to complete upgrade. Specified in the format projects/locations/clusters/nodePools.
CompleteNodePoolUpgradeRequest $postBody
array $optParams

Optional parameters.

Return Value

ContainerEmpty

Exceptions

Exception

at line 71
Operation create(string $parent, CreateNodePoolRequest $postBody, array $optParams = [])

Creates a node pool for a cluster. (nodePools.create)

Parameters

string $parent

The parent (project, location, cluster name) where the node pool will be created. Specified in the format projects/locations/clusters.
CreateNodePoolRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 100
Operation delete(string $name, array $optParams = [])

Deletes a node pool from a cluster. (nodePools.delete)

Parameters

string $name

The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format projects/locations/clusters/nodePools.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 129
NodePool get(string $name, array $optParams = [])

Retrieves the requested node pool. (nodePools.get)

Parameters

string $name

The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format projects/locations/clusters/nodePools.
array $optParams

Optional parameters.

Return Value

NodePool

Exceptions

Exception

at line 157
ListNodePoolsResponse listProjectsLocationsClustersNodePools(string $parent, array $optParams = [])

Lists the node pools for a cluster.

(nodePools.listProjectsLocationsClustersNodePools)

Parameters

string $parent

The parent (project, location, cluster name) where the node pools will be listed. Specified in the format projects/locations/clusters.
array $optParams

Optional parameters.

Return Value

ListNodePoolsResponse

Exceptions

Exception

at line 175
Operation rollback(string $name, RollbackNodePoolUpgradeRequest $postBody, array $optParams = [])

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. (nodePools.rollback)

Parameters

string $name

The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format projects/locations/clusters/nodePools.
RollbackNodePoolUpgradeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 193
Operation setAutoscaling(string $name, SetNodePoolAutoscalingRequest $postBody, array $optParams = [])

Sets the autoscaling settings for the specified node pool.

(nodePools.setAutoscaling)

Parameters

string $name

The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format projects/locations/clusters/nodePools.
SetNodePoolAutoscalingRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 210
Operation setManagement(string $name, SetNodePoolManagementRequest $postBody, array $optParams = [])

Sets the NodeManagement options for a node pool. (nodePools.setManagement)

Parameters

string $name

The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format projects/locations/clusters/nodePools.
SetNodePoolManagementRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 229
Operation setSize(string $name, SetNodePoolSizeRequest $postBody, array $optParams = [])

Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

(nodePools.setSize)

Parameters

string $name

The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format projects/locations/clusters/nodePools.
SetNodePoolSizeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 247
Operation update(string $name, UpdateNodePoolRequest $postBody, array $optParams = [])

Updates the version and/or image type for the specified node pool.

(nodePools.update)

Parameters

string $name

The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/locations/clusters/nodePools.
UpdateNodePoolRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception