Google Cloud Container V1 Client - Class ClusterManagerClient (1.22.0)

Version 1.22.0

• 2.3.1 (latest)
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.3
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.1
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.1
• 1.10.3
• 1.9.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
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() .

Parameters
Name	Description
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() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\CheckAutopilotCompatibilityResponse

completeIPRotation

Completes master IP rotation.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::completeIPRotationAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

completeNodePoolUpgrade

CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::completeNodePoolUpgradeAsync() .

Parameters
Name	Description
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() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\CreateClusterRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

createNodePool

Creates a node pool for a cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::createNodePoolAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\CreateNodePoolRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

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

Parameters
Name	Description
request	Google\Cloud\Container\V1\DeleteClusterRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

deleteNodePool

Deletes a node pool from a cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::deleteNodePoolAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\DeleteNodePoolRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

getCluster

Gets the details of a specific cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetClusterRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Cluster

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

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetJSONWebKeysRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\GetJSONWebKeysResponse

getNodePool

Retrieves the requested node pool.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getNodePoolAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetNodePoolRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\NodePool

getOperation

Gets the specified operation.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getOperationAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetOperationRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

getServerConfig

Returns configuration info about the Google Kubernetes Engine service.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::getServerConfigAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\ServerConfig

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

Parameters
Name	Description
request	Google\Cloud\Container\V1\ListClustersRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\ListClustersResponse

listNodePools

Lists the node pools for a cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::listNodePoolsAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\ListNodePoolsRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\ListNodePoolsResponse

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

Parameters
Name	Description
request	Google\Cloud\Container\V1\ListOperationsRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\ListOperationsResponse

listUsableSubnetworks

Lists subnetworks that are usable for creating clusters in a project.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::listUsableSubnetworksAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\ApiCore\PagedListResponse

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

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setAddonsConfig

Sets the addons for a specific cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setAddonsConfigAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setLabels

Sets labels on a cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setLabelsAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetLabelsRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setLegacyAbac

Enables or disables the ABAC authorization mechanism on a cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setLegacyAbacAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetLegacyAbacRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

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

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetLocationsRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setLoggingService

Sets the logging service for a specific cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setLoggingServiceAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setMaintenancePolicy

Sets the maintenance policy for a cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setMaintenancePolicyAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\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.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setMasterAuthAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetMasterAuthRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setMonitoringService

Sets the monitoring service for a specific cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setMonitoringServiceAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setNetworkPolicy

Enables or disables Network Policy for a cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setNetworkPolicyAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setNodePoolAutoscaling

Sets the autoscaling settings for the specified node pool.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setNodePoolAutoscalingAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

setNodePoolManagement

Sets the NodeManagement options for a node pool.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::setNodePoolManagementAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

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

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

startIPRotation

Starts master IP rotation.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::startIPRotationAsync() .

Parameters
Name	Description
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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

updateCluster

Updates the settings of a specific cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::updateClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\UpdateClusterRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

updateMaster

Updates the master for a specific cluster.

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::updateMasterAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\UpdateMasterRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

updateNodePool

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

The async variant is Google\Cloud\Container\V1\Client\ClusterManagerClient::updateNodePoolAsync() .

Parameters
Name	Description
request	Google\Cloud\Container\V1\UpdateNodePoolRequest 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.

Returns
Type	Description
Google\Cloud\Container\V1\Operation

cancelOperationAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\CancelOperationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

checkAutopilotCompatibilityAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\CheckAutopilotCompatibilityRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

completeIPRotationAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\CompleteIPRotationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

completeNodePoolUpgradeAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\CompleteNodePoolUpgradeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createClusterAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\CreateClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createNodePoolAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\CreateNodePoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteClusterAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\DeleteClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteNodePoolAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\DeleteNodePoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getClusterAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getJSONWebKeysAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetJSONWebKeysRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getNodePoolAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetNodePoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetOperationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getServerConfigAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\GetServerConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listClustersAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\ListClustersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listNodePoolsAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\ListNodePoolsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listOperationsAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\ListOperationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listUsableSubnetworksAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\ListUsableSubnetworksRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

rollbackNodePoolUpgradeAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\RollbackNodePoolUpgradeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setAddonsConfigAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetAddonsConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setLabelsAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetLabelsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setLegacyAbacAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetLegacyAbacRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setLoggingServiceAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetLoggingServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setMaintenancePolicyAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetMaintenancePolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setMasterAuthAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetMasterAuthRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setMonitoringServiceAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetMonitoringServiceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setNetworkPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetNetworkPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setNodePoolAutoscalingAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetNodePoolAutoscalingRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setNodePoolManagementAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetNodePoolManagementRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setNodePoolSizeAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\SetNodePoolSizeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

startIPRotationAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\StartIPRotationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateClusterAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\UpdateClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateMasterAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\UpdateMasterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateNodePoolAsync

Parameters
Name	Description
request	Google\Cloud\Container\V1\UpdateNodePoolRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

static::topicName

Formats a string containing the fully-qualified path to represent a topic resource.

Parameters
Name	Description
project	string
topic	string

Returns
Type	Description
string	The formatted topic resource.

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.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.