Reference documentation and code samples for the Google Cloud Container V1 Client class ClusterManagerClient.
Service Description: Google Kubernetes Engine Cluster Manager v1
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This class is currently experimental and may be subject to changes. See Google\Cloud\Container\V1\ClusterManagerClient for the stable implementation
Namespace
Google \ Cloud \ Container \ V1 \ ClientMethods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
cancelOperation
Cancels the specified operation.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::cancelOperationAsync() .
request
Google\Cloud\Container\V1\CancelOperationRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
checkAutopilotCompatibility
Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::checkAutopilotCompatibilityAsync() .
request
Google\Cloud\Container\V1\CheckAutopilotCompatibilityRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
completeIPRotation
Completes master IP rotation.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::completeIPRotationAsync() .
request
Google\Cloud\Container\V1\CompleteIPRotationRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
completeNodePoolUpgrade
CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::completeNodePoolUpgradeAsync() .
request
Google\Cloud\Container\V1\CompleteNodePoolUpgradeRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createCluster
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 .
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.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::createClusterAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
createNodePool
Creates a node pool for a cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::createNodePoolAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteCluster
Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
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.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::deleteClusterAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteNodePool
Deletes a node pool from a cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::deleteNodePoolAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getCluster
Gets the details of a specific cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getClusterAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getJSONWebKeys
Gets the public component of the cluster signing keys in JSON Web Key format.
This API is not yet intended for general use, and is not available for all clusters.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getJSONWebKeysAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getNodePool
Retrieves the requested node pool.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getNodePoolAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getOperation
Gets the specified operation.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getOperationAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getServerConfig
Returns configuration info about the Google Kubernetes Engine service.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getServerConfigAsync() .
request
Google\Cloud\Container\V1\GetServerConfigRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listClusters
Lists all clusters owned by a project in either the specified zone or all zones.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::listClustersAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listNodePools
Lists the node pools for a cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::listNodePoolsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listOperations
Lists all operations in a project in a specific zone or all zones.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::listOperationsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listUsableSubnetworks
Lists subnetworks that are usable for creating clusters in a project.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::listUsableSubnetworksAsync() .
request
Google\Cloud\Container\V1\ListUsableSubnetworksRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
rollbackNodePoolUpgrade
Rolls back a previously Aborted or Failed NodePool upgrade.
This makes no changes if the last upgrade successfully completed.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::rollbackNodePoolUpgradeAsync() .
request
Google\Cloud\Container\V1\RollbackNodePoolUpgradeRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setAddonsConfig
Sets the addons for a specific cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setAddonsConfigAsync() .
request
Google\Cloud\Container\V1\SetAddonsConfigRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setLabels
Sets labels on a cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setLabelsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setLegacyAbac
Enables or disables the ABAC authorization mechanism on a cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setLegacyAbacAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setLocations
Sets the locations for a specific cluster.
Deprecated. Use projects.locations.clusters.update instead.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setLocationsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setLoggingService
Sets the logging service for a specific cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setLoggingServiceAsync() .
request
Google\Cloud\Container\V1\SetLoggingServiceRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setMaintenancePolicy
Sets the maintenance policy for a cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setMaintenancePolicyAsync() .
request
Google\Cloud\Container\V1\SetMaintenancePolicyRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setMasterAuth
Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setMasterAuthAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setMonitoringService
Sets the monitoring service for a specific cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setMonitoringServiceAsync() .
request
Google\Cloud\Container\V1\SetMonitoringServiceRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setNetworkPolicy
Enables or disables Network Policy for a cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setNetworkPolicyAsync() .
request
Google\Cloud\Container\V1\SetNetworkPolicyRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setNodePoolAutoscaling
Sets the autoscaling settings for the specified node pool.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setNodePoolAutoscalingAsync() .
request
Google\Cloud\Container\V1\SetNodePoolAutoscalingRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setNodePoolManagement
Sets the NodeManagement options for a node pool.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setNodePoolManagementAsync() .
request
Google\Cloud\Container\V1\SetNodePoolManagementRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setNodePoolSize
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 .
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setNodePoolSizeAsync() .
request
Google\Cloud\Container\V1\SetNodePoolSizeRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
startIPRotation
Starts master IP rotation.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::startIPRotationAsync() .
request
Google\Cloud\Container\V1\StartIPRotationRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateCluster
Updates the settings of a specific cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::updateClusterAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateMaster
Updates the master for a specific cluster.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::updateMasterAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateNodePool
Updates the version and/or image type for the specified node pool.
The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::updateNodePoolAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
cancelOperationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
checkAutopilotCompatibilityAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
completeIPRotationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
completeNodePoolUpgradeAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createNodePoolAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteNodePoolAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getJSONWebKeysAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getNodePoolAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getOperationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getServerConfigAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listClustersAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listNodePoolsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listOperationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listUsableSubnetworksAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
rollbackNodePoolUpgradeAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setAddonsConfigAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setLabelsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setLegacyAbacAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setLoggingServiceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setMaintenancePolicyAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setMasterAuthAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setMonitoringServiceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setNetworkPolicyAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setNodePoolAutoscalingAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setNodePoolManagementAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setNodePoolSizeAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
startIPRotationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateMasterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateNodePoolAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::topicName
Formats a string containing the fully-qualified path to represent a topic resource.
project
string
topic
string
string
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- topic: projects/{project}/topics/{topic}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
