Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Container_ProjectsZonesClusters_Resource Class Reference

The "clusters" collection of methods. More...

Inheritance diagram for Google_Service_Container_ProjectsZonesClusters_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 create ($projectId, $zone, Google_Service_Container_CreateClusterRequest $postBody, $optParams=array())
 Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master endpoint.
 
 delete ($projectId, $zone, $clusterId, $optParams=array())
 Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
 
 get ($projectId, $zone, $clusterId, $optParams=array())
 Gets a specific cluster.
 
 listProjectsZonesClusters ($projectId, $zone, $optParams=array())
 Lists all clusters owned by a project in either the specified zone or all zones.
 
 update ($projectId, $zone, $clusterId, Google_Service_Container_UpdateClusterRequest $postBody, $optParams=array())
 Update settings of a specific cluster.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "clusters" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ create()

Google_Service_Container_ProjectsZonesClusters_Resource::create ( $projectId,
$zone,
Google_Service_Container_CreateClusterRequest $postBody,
$optParams = array() )

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master endpoint.

By default, the cluster is created in the project's default network. One firewall is added for the cluster. After cluster creation, the cluster 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 is being used by the cluster. (clusters.create)

Parameters
string$projectIdThe Google Developers Console project ID or project number.
string$zoneThe name of the Google Compute Engine zone in which the cluster resides.
Google_CreateClusterRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Container_Operation

◆ delete()

Google_Service_Container_ProjectsZonesClusters_Resource::delete ( $projectId,
$zone,
$clusterId,
$optParams = array() )

Deletes the cluster, including the Kubernetes endpoint and all worker nodes.

Firewalls and routes that were configured during cluster creation are also deleted. (clusters.delete)

Parameters
string$projectIdThe Google Developers Console project ID or project number.
string$zoneThe name of the Google Compute Engine zone in which the cluster resides.
string$clusterIdThe name of the cluster to delete.
array$optParamsOptional parameters.
Return values
Google_Service_Container_Operation

◆ get()

Google_Service_Container_ProjectsZonesClusters_Resource::get ( $projectId,
$zone,
$clusterId,
$optParams = array() )

Gets a specific cluster.

(clusters.get)

Parameters
string$projectIdThe Google Developers Console project ID or project number.
string$zoneThe name of the Google Compute Engine zone in which the cluster resides.
string$clusterIdThe name of the cluster to retrieve.
array$optParamsOptional parameters.
Return values
Google_Service_Container_Cluster

◆ listProjectsZonesClusters()

Google_Service_Container_ProjectsZonesClusters_Resource::listProjectsZonesClusters ( $projectId,
$zone,
$optParams = array() )

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

(clusters.listProjectsZonesClusters)

Parameters
string$projectIdThe Google Developers Console project ID or project number.
string$zoneThe name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones.
array$optParamsOptional parameters.
Return values
Google_Service_Container_ListClustersResponse

◆ update()

Google_Service_Container_ProjectsZonesClusters_Resource::update ( $projectId,
$zone,
$clusterId,
Google_Service_Container_UpdateClusterRequest $postBody,
$optParams = array() )

Update settings of a specific cluster.

(clusters.update)

Parameters
string$projectIdThe Google Developers Console project ID or project number.
string$zoneThe name of the Google Compute Engine zone in which the cluster resides.
string$clusterIdThe name of the cluster to upgrade.
Google_UpdateClusterRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Container_Operation

The documentation for this class was generated from the following file: