Documentation

Google_Service_Container_Resource_ProjectsZonesClusters extends Google_Service_Resource
in package

Application

The "clusters" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
addons() : Google_Service_Container_Operation: Sets the addons for a specific cluster. (clusters.addons)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
completeIpRotation() : Google_Service_Container_Operation: Completes master IP rotation. (clusters.completeIpRotation)
create() : Google_Service_Container_Operation: Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and- firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. (clusters.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Container_Operation: Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
get() : Google_Service_Container_Cluster: Gets the details of a specific cluster. (clusters.get)
legacyAbac() : Google_Service_Container_Operation: Enables or disables the ABAC authorization mechanism on a cluster.
listProjectsZonesClusters() : Google_Service_Container_ListClustersResponse: Lists all clusters owned by a project in either the specified zone or all zones. (clusters.listProjectsZonesClusters)
locations() : Google_Service_Container_Operation: Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes- engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
logging() : Google_Service_Container_Operation: Sets the logging service for a specific cluster. (clusters.logging)
master() : Google_Service_Container_Operation: Updates the master for a specific cluster. (clusters.master)
monitoring() : Google_Service_Container_Operation: Sets the monitoring service for a specific cluster. (clusters.monitoring)
resourceLabels() : Google_Service_Container_Operation: Sets labels on a cluster. (clusters.resourceLabels)
setMaintenancePolicy() : Google_Service_Container_Operation: Sets the maintenance policy for a cluster. (clusters.setMaintenancePolicy)
setMasterAuth() : Google_Service_Container_Operation: Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. (clusters.setMasterAuth)
setNetworkPolicy() : Google_Service_Container_Operation: Enables or disables Network Policy for a cluster. (clusters.setNetworkPolicy)
startIpRotation() : Google_Service_Container_Operation: Starts master IP rotation. (clusters.startIpRotation)
update() : Google_Service_Container_Operation: Updates the settings of a specific cluster. (clusters.update)
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 —

addons()

Sets the addons for a specific cluster. (clusters.addons)


    public
                addons(string $projectId, string $zone, string $clusterId, Google_Service_Container_SetAddonsConfigRequest $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 upgrade. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetAddonsConfigRequest
$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 —

completeIpRotation()

Completes master IP rotation. (clusters.completeIpRotation)


    public
                completeIpRotation(string $projectId, string $zone, string $clusterId, Google_Service_Container_CompleteIPRotationRequest $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. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_CompleteIPRotationRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

create()

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and- firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. (clusters.create)


    public
                create(string $projectId, string $zone, Google_Service_Container_CreateClusterRequest $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.
$postBody : Google_Service_Container_CreateClusterRequest
$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 the cluster, including the Kubernetes endpoint and all worker nodes.


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

Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created. (clusters.delete)

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 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()

Gets the details of a specific cluster. (clusters.get)


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

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 retrieve. This field has been deprecated and replaced by the name field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Cluster —

legacyAbac()

Enables or disables the ABAC authorization mechanism on a cluster.


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

(clusters.legacyAbac)

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.
$postBody : Google_Service_Container_SetLegacyAbacRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

listProjectsZonesClusters()

Lists all clusters owned by a project in either the specified zone or all zones. (clusters.listProjectsZonesClusters)


    public
                listProjectsZonesClusters(string $projectId, string $zone[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_ListClustersResponse

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, or "-" for all zones. This field has been deprecated and replaced by the parent field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_ListClustersResponse —

locations()

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes- engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.


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

(clusters.locations)

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.
$postBody : Google_Service_Container_SetLocationsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

logging()

Sets the logging service for a specific cluster. (clusters.logging)


    public
                logging(string $projectId, string $zone, string $clusterId, Google_Service_Container_SetLoggingServiceRequest $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 upgrade. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetLoggingServiceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

master()

Updates the master for a specific cluster. (clusters.master)


    public
                master(string $projectId, string $zone, string $clusterId, Google_Service_Container_UpdateMasterRequest $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 upgrade. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_UpdateMasterRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

monitoring()

Sets the monitoring service for a specific cluster. (clusters.monitoring)


    public
                monitoring(string $projectId, string $zone, string $clusterId, Google_Service_Container_SetMonitoringServiceRequest $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 upgrade. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetMonitoringServiceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

resourceLabels()

Sets labels on a cluster. (clusters.resourceLabels)


    public
                resourceLabels(string $projectId, string $zone, string $clusterId, Google_Service_Container_SetLabelsRequest $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. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetLabelsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setMaintenancePolicy()

Sets the maintenance policy for a cluster. (clusters.setMaintenancePolicy)


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

Parameters

$projectId : string: Required. The Google Developers Console project ID or project number.
$zone : string: Required. The name of the Google Compute Engine zone in which the cluster resides.
$clusterId : string: Required. The name of the cluster to update.
$postBody : Google_Service_Container_SetMaintenancePolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setMasterAuth()

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. (clusters.setMasterAuth)


    public
                setMasterAuth(string $projectId, string $zone, string $clusterId, Google_Service_Container_SetMasterAuthRequest $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 upgrade. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetMasterAuthRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setNetworkPolicy()

Enables or disables Network Policy for a cluster. (clusters.setNetworkPolicy)


    public
                setNetworkPolicy(string $projectId, string $zone, string $clusterId, Google_Service_Container_SetNetworkPolicyRequest $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. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_SetNetworkPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

startIpRotation()

Starts master IP rotation. (clusters.startIpRotation)


    public
                startIpRotation(string $projectId, string $zone, string $clusterId, Google_Service_Container_StartIPRotationRequest $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. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_StartIPRotationRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

update()

Updates the settings of a specific cluster. (clusters.update)


    public
                update(string $projectId, string $zone, string $clusterId, Google_Service_Container_UpdateClusterRequest $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 upgrade. This field has been deprecated and replaced by the name field.
$postBody : Google_Service_Container_UpdateClusterRequest
$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 —