Documentation

Google_Service_Container_Resource_ProjectsZonesClustersNodePools extends Google_Service_Resource
in package

Application

The "nodePools" collection of methods.

Typical usage is: $containerService = new Google_Service_Container(...); $nodePools = $containerService->nodePools;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
autoscaling() : Google_Service_Container_Operation: Sets the autoscaling settings for the specified node pool.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Container_Operation: Creates a node pool for a cluster. (nodePools.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Container_Operation: Deletes a node pool from a cluster. (nodePools.delete)
get() : Google_Service_Container_NodePool: Retrieves the requested node pool. (nodePools.get)
listProjectsZonesClustersNodePools() : Google_Service_Container_ListNodePoolsResponse: Lists the node pools for a cluster.
rollback() : Google_Service_Container_Operation: Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. (nodePools.rollback)
setManagement() : Google_Service_Container_Operation: Sets the NodeManagement options for a node pool. (nodePools.setManagement)
setSize() : Google_Service_Container_Operation: Sets the size for a specific node pool. (nodePools.setSize)
update() : Google_Service_Container_Operation: Updates the version and/or image type for the specified node pool.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

autoscaling()

Sets the autoscaling settings for the specified node pool.


    public
                autoscaling(string $projectId, string $zone, string $clusterId, string $nodePoolId, Google_Service_Container_SetNodePoolAutoscalingRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

(nodePools.autoscaling)

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
$clusterId : string: Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
$nodePoolId : string: Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetNodePoolAutoscalingRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

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


    public
                create(string $projectId, string $zone, string $clusterId, Google_Service_Container_CreateNodePoolRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
$clusterId : string: Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
$postBody : Google_Service_Container_CreateNodePoolRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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


    public
                delete(string $projectId, string $zone, string $clusterId, string $nodePoolId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
$clusterId : string: Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
$nodePoolId : string: Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

get()

Retrieves the requested node pool. (nodePools.get)


    public
                get(string $projectId, string $zone, string $clusterId, string $nodePoolId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_NodePool

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
$clusterId : string: Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
$nodePoolId : string: Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_NodePool —

listProjectsZonesClustersNodePools()

Lists the node pools for a cluster.


    public
                listProjectsZonesClustersNodePools(string $projectId, string $zone, string $clusterId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_ListNodePoolsResponse

(nodePools.listProjectsZonesClustersNodePools)

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
$clusterId : string: Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_ListNodePoolsResponse —

rollback()

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


    public
                rollback(string $projectId, string $zone, string $clusterId, string $nodePoolId, Google_Service_Container_RollbackNodePoolUpgradeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
$clusterId : string: Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
$nodePoolId : string: Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_RollbackNodePoolUpgradeRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setManagement()

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


    public
                setManagement(string $projectId, string $zone, string $clusterId, string $nodePoolId, Google_Service_Container_SetNodePoolManagementRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
$clusterId : string: Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
$nodePoolId : string: Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetNodePoolManagementRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setSize()

Sets the size for a specific node pool. (nodePools.setSize)


    public
                setSize(string $projectId, string $zone, string $clusterId, string $nodePoolId, Google_Service_Container_SetNodePoolSizeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
$clusterId : string: Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
$nodePoolId : string: Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetNodePoolSizeRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

update()

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


    public
                update(string $projectId, string $zone, string $clusterId, string $nodePoolId, Google_Service_Container_UpdateNodePoolRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

(nodePools.update)

Parameters

$projectId : string: Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
$zone : string: Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
$clusterId : string: Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
$nodePoolId : string: Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_UpdateNodePoolRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —