Documentation

Google_Service_Container_Resource_ProjectsLocationsClusters 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
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)
getJwks() : Google_Service_Container_GetJSONWebKeysResponse: Gets the public component of the cluster signing keys in JSON Web Key format.
listProjectsLocationsClusters() : Google_Service_Container_ListClustersResponse: Lists all clusters owned by a project in either the specified zone or all zones. (clusters.listProjectsLocationsClusters)
setAddons() : Google_Service_Container_Operation: Sets the addons for a specific cluster. (clusters.setAddons)
setLegacyAbac() : Google_Service_Container_Operation: Enables or disables the ABAC authorization mechanism on a cluster.
setLocations() : 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.
setLogging() : Google_Service_Container_Operation: Sets the logging service for a specific cluster. (clusters.setLogging)
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)
setMonitoring() : Google_Service_Container_Operation: Sets the monitoring service for a specific cluster. (clusters.setMonitoring)
setNetworkPolicy() : Google_Service_Container_Operation: Enables or disables Network Policy for a cluster. (clusters.setNetworkPolicy)
setResourceLabels() : Google_Service_Container_Operation: Sets labels on a cluster. (clusters.setResourceLabels)
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)
updateMaster() : Google_Service_Container_Operation: Updates the master for a specific cluster. (clusters.updateMaster)
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 —

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 $name, Google_Service_Container_CompleteIPRotationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format projects/locations/clusters.
$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 $parent, Google_Service_Container_CreateClusterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$parent : string: The parent (project and location) where the cluster will be created. Specified in the format projects/locations.
$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 $name[, 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

$name : string: The name (project, location, cluster) of the cluster to delete. Specified in the format projects/locations/clusters.
$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 $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Cluster

Parameters

$name : string: The name (project, location, cluster) of the cluster to retrieve. Specified in the format projects/locations/clusters.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Cluster —

getJwks()

Gets the public component of the cluster signing keys in JSON Web Key format.


    public
                getJwks(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_GetJSONWebKeysResponse

This API is not yet intended for general use, and is not available for all clusters. (clusters.getJwks)

Parameters

$parent : string: The cluster (project, location, cluster id) to get keys for. Specified in the format projects/locations/clusters.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_GetJSONWebKeysResponse —

listProjectsLocationsClusters()

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


    public
                listProjectsLocationsClusters(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_ListClustersResponse

Parameters

$parent : string: The parent (project and location) where the clusters will be listed. Specified in the format projects/locations. Location "-" matches all zones and all regions.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_ListClustersResponse —

setAddons()

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


    public
                setAddons(string $name, Google_Service_Container_SetAddonsConfigRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster) of the cluster to set addons. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_SetAddonsConfigRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setLegacyAbac()

Enables or disables the ABAC authorization mechanism on a cluster.


    public
                setLegacyAbac(string $name, Google_Service_Container_SetLegacyAbacRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

(clusters.setLegacyAbac)

Parameters

$name : string: The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_SetLegacyAbacRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setLocations()

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
                setLocations(string $name, Google_Service_Container_SetLocationsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

(clusters.setLocations)

Parameters

$name : string: The name (project, location, cluster) of the cluster to set locations. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_SetLocationsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setLogging()

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


    public
                setLogging(string $name, Google_Service_Container_SetLoggingServiceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster) of the cluster to set logging. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_SetLoggingServiceRequest
$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 $name, Google_Service_Container_SetMaintenancePolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format projects/locations/clusters.
$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 $name, Google_Service_Container_SetMasterAuthRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster) of the cluster to set auth. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_SetMasterAuthRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setMonitoring()

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


    public
                setMonitoring(string $name, Google_Service_Container_SetMonitoringServiceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster) of the cluster to set monitoring. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_SetMonitoringServiceRequest
$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 $name, Google_Service_Container_SetNetworkPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_SetNetworkPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

setResourceLabels()

Sets labels on a cluster. (clusters.setResourceLabels)


    public
                setResourceLabels(string $name, Google_Service_Container_SetLabelsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster id) of the cluster to set labels. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_SetLabelsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

startIpRotation()

Starts master IP rotation. (clusters.startIpRotation)


    public
                startIpRotation(string $name, Google_Service_Container_StartIPRotationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format projects/locations/clusters.
$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 $name, Google_Service_Container_UpdateClusterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster) of the cluster to update. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_UpdateClusterRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Container_Operation —

updateMaster()

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


    public
                updateMaster(string $name, Google_Service_Container_UpdateMasterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Container_Operation

Parameters

$name : string: The name (project, location, cluster) of the cluster to update. Specified in the format projects/locations/clusters.
$postBody : Google_Service_Container_UpdateMasterRequest
$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 —