google::cloud::container_v1::ClusterManagerClient Class Reference

Google Kubernetes Engine Cluster Manager v1. More...

#include <google/cloud/container/v1/cluster_manager_client.h>

Public Member Functions
	ClusterManagerClient (std::shared_ptr< ClusterManagerConnection > connection, Options opts={})
	~ClusterManagerClient ()
StatusOr< google::container::v1::ListClustersResponse >	ListClusters (std::string const &parent, Options opts={})
	Lists all clusters owned by a project in either the specified zone or all zones. More...
StatusOr< google::container::v1::ListClustersResponse >	ListClusters (google::container::v1::ListClustersRequest const &request, Options opts={})
	Lists all clusters owned by a project in either the specified zone or all zones. More...
StatusOr< google::container::v1::Cluster >	GetCluster (std::string const &name, Options opts={})
	Gets the details of a specific cluster. More...
StatusOr< google::container::v1::Cluster >	GetCluster (google::container::v1::GetClusterRequest const &request, Options opts={})
	Gets the details of a specific cluster. More...
StatusOr< google::container::v1::Operation >	CreateCluster (std::string const &parent, google::container::v1::Cluster const &cluster, Options opts={})
	Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. More...
StatusOr< google::container::v1::Operation >	CreateCluster (google::container::v1::CreateClusterRequest const &request, Options opts={})
	Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. More...
StatusOr< google::container::v1::Operation >	UpdateCluster (std::string const &name, google::container::v1::ClusterUpdate const &update, Options opts={})
	Updates the settings of a specific cluster. More...
StatusOr< google::container::v1::Operation >	UpdateCluster (google::container::v1::UpdateClusterRequest const &request, Options opts={})
	Updates the settings of a specific cluster. More...
StatusOr< google::container::v1::Operation >	UpdateNodePool (google::container::v1::UpdateNodePoolRequest const &request, Options opts={})
	Updates the version and/or image type for the specified node pool. More...
StatusOr< google::container::v1::Operation >	SetNodePoolAutoscaling (google::container::v1::SetNodePoolAutoscalingRequest const &request, Options opts={})
	Sets the autoscaling settings for the specified node pool. More...
StatusOr< google::container::v1::Operation >	SetLoggingService (std::string const &name, std::string const &logging_service, Options opts={})
	Sets the logging service for a specific cluster. More...
StatusOr< google::container::v1::Operation >	SetLoggingService (google::container::v1::SetLoggingServiceRequest const &request, Options opts={})
	Sets the logging service for a specific cluster. More...
StatusOr< google::container::v1::Operation >	SetMonitoringService (std::string const &name, std::string const &monitoring_service, Options opts={})
	Sets the monitoring service for a specific cluster. More...
StatusOr< google::container::v1::Operation >	SetMonitoringService (google::container::v1::SetMonitoringServiceRequest const &request, Options opts={})
	Sets the monitoring service for a specific cluster. More...
StatusOr< google::container::v1::Operation >	SetAddonsConfig (std::string const &name, google::container::v1::AddonsConfig const &addons_config, Options opts={})
	Sets the addons for a specific cluster. More...
StatusOr< google::container::v1::Operation >	SetAddonsConfig (google::container::v1::SetAddonsConfigRequest const &request, Options opts={})
	Sets the addons for a specific cluster. More...
StatusOr< google::container::v1::Operation >	SetLocations (std::string const &name, std::vector< std::string > const &locations, Options opts={})
	Sets the locations for a specific cluster. More...
StatusOr< google::container::v1::Operation >	SetLocations (google::container::v1::SetLocationsRequest const &request, Options opts={})
	Sets the locations for a specific cluster. More...
StatusOr< google::container::v1::Operation >	UpdateMaster (std::string const &name, std::string const &master_version, Options opts={})
	Updates the master for a specific cluster. More...
StatusOr< google::container::v1::Operation >	UpdateMaster (google::container::v1::UpdateMasterRequest const &request, Options opts={})
	Updates the master for a specific cluster. More...
StatusOr< google::container::v1::Operation >	SetMasterAuth (google::container::v1::SetMasterAuthRequest const &request, Options opts={})
	Sets master auth materials. More...
StatusOr< google::container::v1::Operation >	DeleteCluster (std::string const &name, Options opts={})
	Deletes the cluster, including the Kubernetes endpoint and all worker nodes. More...
StatusOr< google::container::v1::Operation >	DeleteCluster (google::container::v1::DeleteClusterRequest const &request, Options opts={})
	Deletes the cluster, including the Kubernetes endpoint and all worker nodes. More...
StatusOr< google::container::v1::ListOperationsResponse >	ListOperations (google::container::v1::ListOperationsRequest const &request, Options opts={})
	Lists all operations in a project in a specific zone or all zones. More...
StatusOr< google::container::v1::Operation >	GetOperation (std::string const &name, Options opts={})
	Gets the specified operation. More...
StatusOr< google::container::v1::Operation >	GetOperation (google::container::v1::GetOperationRequest const &request, Options opts={})
	Gets the specified operation. More...
Status	CancelOperation (std::string const &name, Options opts={})
	Cancels the specified operation. More...
Status	CancelOperation (google::container::v1::CancelOperationRequest const &request, Options opts={})
	Cancels the specified operation. More...
StatusOr< google::container::v1::ServerConfig >	GetServerConfig (std::string const &name, Options opts={})
	Returns configuration info about the Google Kubernetes Engine service. More...
StatusOr< google::container::v1::ServerConfig >	GetServerConfig (google::container::v1::GetServerConfigRequest const &request, Options opts={})
	Returns configuration info about the Google Kubernetes Engine service. More...
StatusOr< google::container::v1::GetJSONWebKeysResponse >	GetJSONWebKeys (google::container::v1::GetJSONWebKeysRequest const &request, Options opts={})
	Gets the public component of the cluster signing keys in JSON Web Key format. More...
StatusOr< google::container::v1::ListNodePoolsResponse >	ListNodePools (std::string const &parent, Options opts={})
	Lists the node pools for a cluster. More...
StatusOr< google::container::v1::ListNodePoolsResponse >	ListNodePools (google::container::v1::ListNodePoolsRequest const &request, Options opts={})
	Lists the node pools for a cluster. More...
StatusOr< google::container::v1::NodePool >	GetNodePool (std::string const &name, Options opts={})
	Retrieves the requested node pool. More...
StatusOr< google::container::v1::NodePool >	GetNodePool (google::container::v1::GetNodePoolRequest const &request, Options opts={})
	Retrieves the requested node pool. More...
StatusOr< google::container::v1::Operation >	CreateNodePool (std::string const &parent, google::container::v1::NodePool const &node_pool, Options opts={})
	Creates a node pool for a cluster. More...
StatusOr< google::container::v1::Operation >	CreateNodePool (google::container::v1::CreateNodePoolRequest const &request, Options opts={})
	Creates a node pool for a cluster. More...
StatusOr< google::container::v1::Operation >	DeleteNodePool (std::string const &name, Options opts={})
	Deletes a node pool from a cluster. More...
StatusOr< google::container::v1::Operation >	DeleteNodePool (google::container::v1::DeleteNodePoolRequest const &request, Options opts={})
	Deletes a node pool from a cluster. More...
Status	CompleteNodePoolUpgrade (google::container::v1::CompleteNodePoolUpgradeRequest const &request, Options opts={})
	CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete. More...
StatusOr< google::container::v1::Operation >	RollbackNodePoolUpgrade (std::string const &name, Options opts={})
	Rolls back a previously Aborted or Failed NodePool upgrade. More...
StatusOr< google::container::v1::Operation >	RollbackNodePoolUpgrade (google::container::v1::RollbackNodePoolUpgradeRequest const &request, Options opts={})
	Rolls back a previously Aborted or Failed NodePool upgrade. More...
StatusOr< google::container::v1::Operation >	SetNodePoolManagement (google::container::v1::SetNodePoolManagementRequest const &request, Options opts={})
	Sets the NodeManagement options for a node pool. More...
StatusOr< google::container::v1::Operation >	SetLabels (google::container::v1::SetLabelsRequest const &request, Options opts={})
	Sets labels on a cluster. More...
StatusOr< google::container::v1::Operation >	SetLegacyAbac (std::string const &name, bool enabled, Options opts={})
	Enables or disables the ABAC authorization mechanism on a cluster. More...
StatusOr< google::container::v1::Operation >	SetLegacyAbac (google::container::v1::SetLegacyAbacRequest const &request, Options opts={})
	Enables or disables the ABAC authorization mechanism on a cluster. More...
StatusOr< google::container::v1::Operation >	StartIPRotation (std::string const &name, Options opts={})
	Starts master IP rotation. More...
StatusOr< google::container::v1::Operation >	StartIPRotation (google::container::v1::StartIPRotationRequest const &request, Options opts={})
	Starts master IP rotation. More...
StatusOr< google::container::v1::Operation >	CompleteIPRotation (std::string const &name, Options opts={})
	Completes master IP rotation. More...
StatusOr< google::container::v1::Operation >	CompleteIPRotation (google::container::v1::CompleteIPRotationRequest const &request, Options opts={})
	Completes master IP rotation. More...
StatusOr< google::container::v1::Operation >	SetNodePoolSize (google::container::v1::SetNodePoolSizeRequest const &request, Options opts={})
	Sets the size for a specific node pool. More...
StatusOr< google::container::v1::Operation >	SetNetworkPolicy (std::string const &name, google::container::v1::NetworkPolicy const &network_policy, Options opts={})
	Enables or disables Network Policy for a cluster. More...
StatusOr< google::container::v1::Operation >	SetNetworkPolicy (google::container::v1::SetNetworkPolicyRequest const &request, Options opts={})
	Enables or disables Network Policy for a cluster. More...
StatusOr< google::container::v1::Operation >	SetMaintenancePolicy (std::string const &project_id, std::string const &zone, std::string const &cluster_id, google::container::v1::MaintenancePolicy const &maintenance_policy, Options opts={})
	Sets the maintenance policy for a cluster. More...
StatusOr< google::container::v1::Operation >	SetMaintenancePolicy (std::string const &name, google::container::v1::MaintenancePolicy const &maintenance_policy, Options opts={})
	Sets the maintenance policy for a cluster. More...
StatusOr< google::container::v1::Operation >	SetMaintenancePolicy (google::container::v1::SetMaintenancePolicyRequest const &request, Options opts={})
	Sets the maintenance policy for a cluster. More...
StreamRange< google::container::v1::UsableSubnetwork >	ListUsableSubnetworks (google::container::v1::ListUsableSubnetworksRequest request, Options opts={})
	Lists subnetworks that are usable for creating clusters in a project. More...
StatusOr< google::container::v1::CheckAutopilotCompatibilityResponse >	CheckAutopilotCompatibility (google::container::v1::CheckAutopilotCompatibilityRequest const &request, Options opts={})
	Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues. More...
Copy and move support
	ClusterManagerClient (ClusterManagerClient const &)=default
ClusterManagerClient &	operator= (ClusterManagerClient const &)=default
	ClusterManagerClient (ClusterManagerClient &&)=default
ClusterManagerClient &	operator= (ClusterManagerClient &&)=default

Friends
Equality
bool	operator== (ClusterManagerClient const &a, ClusterManagerClient const &b)
bool	operator!= (ClusterManagerClient const &a, ClusterManagerClient const &b)

Detailed Description

Google Kubernetes Engine Cluster Manager v1.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructor & Destructor Documentation

ClusterManagerClient() [1/3]

google::cloud::container_v1::ClusterManagerClient::ClusterManagerClient ( std::shared_ptr< ClusterManagerConnection >  connection, Options  opts = {}  )

explicit

~ClusterManagerClient()

google::cloud::container_v1::ClusterManagerClient::~ClusterManagerClient

(

)

ClusterManagerClient() [2/3]

google::cloud::container_v1::ClusterManagerClient::ClusterManagerClient ( ClusterManagerClient const &  )

default

ClusterManagerClient() [3/3]

google::cloud::container_v1::ClusterManagerClient::ClusterManagerClient ( ClusterManagerClient &&  )

default

Member Function Documentation

CancelOperation() [1/2]

Status google::cloud::container_v1::ClusterManagerClient::CancelOperation	(	google::container::v1::CancelOperationRequest const &	request,
		Options	opts = {}
	)

Cancels the specified operation.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.CancelOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

CancelOperation() [2/2]

Status google::cloud::container_v1::ClusterManagerClient::CancelOperation	(	std::string const &	name,
		Options	opts = {}
	)

Cancels the specified operation.

Parameters

name	The name (project, location, operation id) of the operation to cancel. Specified in the format projects/*‍/locations/*‍/operations/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

CheckAutopilotCompatibility()

StatusOr< google::container::v1::CheckAutopilotCompatibilityResponse > google::cloud::container_v1::ClusterManagerClient::CheckAutopilotCompatibility	(	google::container::v1::CheckAutopilotCompatibilityRequest const &	request,
		Options	opts = {}
	)

Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.CheckAutopilotCompatibilityRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.CheckAutopilotCompatibilityResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CompleteIPRotation() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::CompleteIPRotation	(	google::container::v1::CompleteIPRotationRequest const &	request,
		Options	opts = {}
	)

Completes master IP rotation.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.CompleteIPRotationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CompleteIPRotation() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::CompleteIPRotation	(	std::string const &	name,
		Options	opts = {}
	)

Completes master IP rotation.

Parameters

name	The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format projects/*‍/locations/*‍/clusters/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CompleteNodePoolUpgrade()

Status google::cloud::container_v1::ClusterManagerClient::CompleteNodePoolUpgrade	(	google::container::v1::CompleteNodePoolUpgradeRequest const &	request,
		Options	opts = {}
	)

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

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.CompleteNodePoolUpgradeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

CreateCluster() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::CreateCluster	(	google::container::v1::CreateClusterRequest const &	request,
		Options	opts = {}
	)

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.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.CreateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateCluster() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::CreateCluster	(	std::string const &	parent,
		google::container::v1::Cluster const &	cluster,
		Options	opts = {}
	)

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.

Parameters

parent	The parent (project and location) where the cluster will be created. Specified in the format projects/*‍/locations/*.
cluster	Required. A cluster resource
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateNodePool() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::CreateNodePool	(	google::container::v1::CreateNodePoolRequest const &	request,
		Options	opts = {}
	)

Creates a node pool for a cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.CreateNodePoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateNodePool() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::CreateNodePool	(	std::string const &	parent,
		google::container::v1::NodePool const &	node_pool,
		Options	opts = {}
	)

Creates a node pool for a cluster.

Parameters

parent	The parent (project, location, cluster name) where the node pool will be created. Specified in the format projects/*‍/locations/*‍/clusters/*.
node_pool	Required. The node pool to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteCluster() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::DeleteCluster	(	google::container::v1::DeleteClusterRequest const &	request,
		Options	opts = {}
	)

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.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.DeleteClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteCluster() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::DeleteCluster	(	std::string const &	name,
		Options	opts = {}
	)

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.

Parameters

name	The name (project, location, cluster) of the cluster to delete. Specified in the format projects/*‍/locations/*‍/clusters/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteNodePool() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::DeleteNodePool	(	google::container::v1::DeleteNodePoolRequest const &	request,
		Options	opts = {}
	)

Deletes a node pool from a cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.DeleteNodePoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteNodePool() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::DeleteNodePool	(	std::string const &	name,
		Options	opts = {}
	)

Deletes a node pool from a cluster.

Parameters

name	The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format projects/*‍/locations/*‍/clusters/*‍/nodePools/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetCluster() [1/2]

StatusOr< google::container::v1::Cluster > google::cloud::container_v1::ClusterManagerClient::GetCluster	(	google::container::v1::GetClusterRequest const &	request,
		Options	opts = {}
	)

Gets the details of a specific cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.GetClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetCluster() [2/2]

StatusOr< google::container::v1::Cluster > google::cloud::container_v1::ClusterManagerClient::GetCluster	(	std::string const &	name,
		Options	opts = {}
	)

Gets the details of a specific cluster.

Parameters

name	The name (project, location, cluster) of the cluster to retrieve. Specified in the format projects/*‍/locations/*‍/clusters/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetJSONWebKeys()

StatusOr< google::container::v1::GetJSONWebKeysResponse > google::cloud::container_v1::ClusterManagerClient::GetJSONWebKeys	(	google::container::v1::GetJSONWebKeysRequest const &	request,
		Options	opts = {}
	)

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.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.GetJSONWebKeysRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.GetJSONWebKeysResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetNodePool() [1/2]

StatusOr< google::container::v1::NodePool > google::cloud::container_v1::ClusterManagerClient::GetNodePool	(	google::container::v1::GetNodePoolRequest const &	request,
		Options	opts = {}
	)

Retrieves the requested node pool.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.GetNodePoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.NodePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetNodePool() [2/2]

StatusOr< google::container::v1::NodePool > google::cloud::container_v1::ClusterManagerClient::GetNodePool	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the requested node pool.

Parameters

name	The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format projects/*‍/locations/*‍/clusters/*‍/nodePools/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.NodePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOperation() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::GetOperation	(	google::container::v1::GetOperationRequest const &	request,
		Options	opts = {}
	)

Gets the specified operation.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.GetOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOperation() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::GetOperation	(	std::string const &	name,
		Options	opts = {}
	)

Gets the specified operation.

Parameters

name	The name (project, location, operation id) of the operation to get. Specified in the format projects/*‍/locations/*‍/operations/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetServerConfig() [1/2]

StatusOr< google::container::v1::ServerConfig > google::cloud::container_v1::ClusterManagerClient::GetServerConfig	(	google::container::v1::GetServerConfigRequest const &	request,
		Options	opts = {}
	)

Returns configuration info about the Google Kubernetes Engine service.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.GetServerConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.ServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetServerConfig() [2/2]

StatusOr< google::container::v1::ServerConfig > google::cloud::container_v1::ClusterManagerClient::GetServerConfig	(	std::string const &	name,
		Options	opts = {}
	)

Returns configuration info about the Google Kubernetes Engine service.

Parameters

name	The name (project and location) of the server config to get, specified in the format projects/*‍/locations/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.ServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListClusters() [1/2]

StatusOr< google::container::v1::ListClustersResponse > google::cloud::container_v1::ClusterManagerClient::ListClusters	(	google::container::v1::ListClustersRequest const &	request,
		Options	opts = {}
	)

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

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.ListClustersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.ListClustersResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListClusters() [2/2]

StatusOr< google::container::v1::ListClustersResponse > google::cloud::container_v1::ClusterManagerClient::ListClusters	(	std::string const &	parent,
		Options	opts = {}
	)

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

Parameters

parent	The parent (project and location) where the clusters will be listed. Specified in the format projects/*‍/locations/*. Location "-" matches all zones and all regions.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.ListClustersResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListNodePools() [1/2]

StatusOr< google::container::v1::ListNodePoolsResponse > google::cloud::container_v1::ClusterManagerClient::ListNodePools	(	google::container::v1::ListNodePoolsRequest const &	request,
		Options	opts = {}
	)

Lists the node pools for a cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.ListNodePoolsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.ListNodePoolsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListNodePools() [2/2]

StatusOr< google::container::v1::ListNodePoolsResponse > google::cloud::container_v1::ClusterManagerClient::ListNodePools	(	std::string const &	parent,
		Options	opts = {}
	)

Lists the node pools for a cluster.

Parameters

parent	The parent (project, location, cluster name) where the node pools will be listed. Specified in the format projects/*‍/locations/*‍/clusters/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.ListNodePoolsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListOperations()

StatusOr< google::container::v1::ListOperationsResponse > google::cloud::container_v1::ClusterManagerClient::ListOperations	(	google::container::v1::ListOperationsRequest const &	request,
		Options	opts = {}
	)

Lists all operations in a project in a specific zone or all zones.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.ListOperationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.ListOperationsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListUsableSubnetworks()

StreamRange< google::container::v1::UsableSubnetwork > google::cloud::container_v1::ClusterManagerClient::ListUsableSubnetworks	(	google::container::v1::ListUsableSubnetworksRequest	request,
		Options	opts = {}
	)

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

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.ListUsableSubnetworksRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a `StatusOr` as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.container.v1.UsableSubnetwork, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

operator=() [1/2]

ClusterManagerClient & google::cloud::container_v1::ClusterManagerClient::operator= ( ClusterManagerClient &&  )

default

operator=() [2/2]

ClusterManagerClient & google::cloud::container_v1::ClusterManagerClient::operator= ( ClusterManagerClient const &  )

default

RollbackNodePoolUpgrade() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::RollbackNodePoolUpgrade	(	google::container::v1::RollbackNodePoolUpgradeRequest const &	request,
		Options	opts = {}
	)

Rolls back a previously Aborted or Failed NodePool upgrade.

This makes no changes if the last upgrade successfully completed.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.RollbackNodePoolUpgradeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RollbackNodePoolUpgrade() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::RollbackNodePoolUpgrade	(	std::string const &	name,
		Options	opts = {}
	)

Rolls back a previously Aborted or Failed NodePool upgrade.

This makes no changes if the last upgrade successfully completed.

Parameters

name	The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format projects/*‍/locations/*‍/clusters/*‍/nodePools/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetAddonsConfig() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetAddonsConfig	(	google::container::v1::SetAddonsConfigRequest const &	request,
		Options	opts = {}
	)

Sets the addons for a specific cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetAddonsConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetAddonsConfig() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetAddonsConfig	(	std::string const &	name,
		google::container::v1::AddonsConfig const &	addons_config,
		Options	opts = {}
	)

Sets the addons for a specific cluster.

Parameters

name	The name (project, location, cluster) of the cluster to set addons. Specified in the format projects/*‍/locations/*‍/clusters/*.
addons_config	Required. The desired configurations for the various addons available to run in the cluster.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetLabels()

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetLabels	(	google::container::v1::SetLabelsRequest const &	request,
		Options	opts = {}
	)

Sets labels on a cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetLabelsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetLegacyAbac() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetLegacyAbac	(	google::container::v1::SetLegacyAbacRequest const &	request,
		Options	opts = {}
	)

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetLegacyAbacRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetLegacyAbac() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetLegacyAbac	(	std::string const &	name,
		bool	enabled,
		Options	opts = {}
	)

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters

name	The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format projects/*‍/locations/*‍/clusters/*.
enabled	Required. Whether ABAC authorization will be enabled in the cluster.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetLocations() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetLocations	(	google::container::v1::SetLocationsRequest const &	request,
		Options	opts = {}
	)

Sets the locations for a specific cluster.

Deprecated. Use projects.locations.clusters.update instead.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetLocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetLocations() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetLocations	(	std::string const &	name,
		std::vector< std::string > const &	locations,
		Options	opts = {}
	)

Sets the locations for a specific cluster.

Deprecated. Use projects.locations.clusters.update instead.

Parameters

name	The name (project, location, cluster) of the cluster to set locations. Specified in the format projects/*‍/locations/*‍/clusters/*.
locations	Required. The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetLoggingService() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetLoggingService	(	google::container::v1::SetLoggingServiceRequest const &	request,
		Options	opts = {}
	)

Sets the logging service for a specific cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetLoggingServiceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetLoggingService() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetLoggingService	(	std::string const &	name,
		std::string const &	logging_service,
		Options	opts = {}
	)

Sets the logging service for a specific cluster.

Parameters

name	The name (project, location, cluster) of the cluster to set logging. Specified in the format projects/*‍/locations/*‍/clusters/*.
logging_service	Required. The logging service the cluster should use to write logs. Currently available options: logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15). none - no logs will be exported from the cluster. If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetMaintenancePolicy() [1/3]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetMaintenancePolicy	(	google::container::v1::SetMaintenancePolicyRequest const &	request,
		Options	opts = {}
	)

Sets the maintenance policy for a cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetMaintenancePolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetMaintenancePolicy() [2/3]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetMaintenancePolicy	(	std::string const &	name,
		google::container::v1::MaintenancePolicy const &	maintenance_policy,
		Options	opts = {}
	)

Sets the maintenance policy for a cluster.

Parameters

name	The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format projects/*‍/locations/*‍/clusters/*.
maintenance_policy	Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetMaintenancePolicy() [3/3]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetMaintenancePolicy	(	std::string const &	project_id,
		std::string const &	zone,
		std::string const &	cluster_id,
		google::container::v1::MaintenancePolicy const &	maintenance_policy,
		Options	opts = {}
	)

Sets the maintenance policy for a cluster.

Parameters

project_id	Required. The Google Developers Console project ID or project number.
zone	Required. The name of the Google Compute Engine zone in which the cluster resides.
cluster_id	Required. The name of the cluster to update.
maintenance_policy	Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetMasterAuth()

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetMasterAuth	(	google::container::v1::SetMasterAuthRequest const &	request,
		Options	opts = {}
	)

Sets master auth materials.

Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetMasterAuthRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetMonitoringService() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetMonitoringService	(	google::container::v1::SetMonitoringServiceRequest const &	request,
		Options	opts = {}
	)

Sets the monitoring service for a specific cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetMonitoringServiceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetMonitoringService() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetMonitoringService	(	std::string const &	name,
		std::string const &	monitoring_service,
		Options	opts = {}
	)

Sets the monitoring service for a specific cluster.

Parameters

name	The name (project, location, cluster) of the cluster to set monitoring. Specified in the format projects/*‍/locations/*‍/clusters/*.
monitoring_service	Required. The monitoring service the cluster should use to write metrics. Currently available options: "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetNetworkPolicy() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetNetworkPolicy	(	google::container::v1::SetNetworkPolicyRequest const &	request,
		Options	opts = {}
	)

Enables or disables Network Policy for a cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetNetworkPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetNetworkPolicy() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetNetworkPolicy	(	std::string const &	name,
		google::container::v1::NetworkPolicy const &	network_policy,
		Options	opts = {}
	)

Enables or disables Network Policy for a cluster.

Parameters

name	The name (project, location, cluster name) of the cluster to set networking policy. Specified in the format projects/*‍/locations/*‍/clusters/*.
network_policy	Required. Configuration options for the NetworkPolicy feature.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetNodePoolAutoscaling()

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetNodePoolAutoscaling	(	google::container::v1::SetNodePoolAutoscalingRequest const &	request,
		Options	opts = {}
	)

Sets the autoscaling settings for the specified node pool.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetNodePoolAutoscalingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetNodePoolManagement()

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetNodePoolManagement	(	google::container::v1::SetNodePoolManagementRequest const &	request,
		Options	opts = {}
	)

Sets the NodeManagement options for a node pool.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetNodePoolManagementRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetNodePoolSize()

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::SetNodePoolSize	(	google::container::v1::SetNodePoolSizeRequest const &	request,
		Options	opts = {}
	)

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.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.SetNodePoolSizeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

StartIPRotation() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::StartIPRotation	(	google::container::v1::StartIPRotationRequest const &	request,
		Options	opts = {}
	)

Starts master IP rotation.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.StartIPRotationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

StartIPRotation() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::StartIPRotation	(	std::string const &	name,
		Options	opts = {}
	)

Starts master IP rotation.

Parameters

name	The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format projects/*‍/locations/*‍/clusters/*.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateCluster() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::UpdateCluster	(	google::container::v1::UpdateClusterRequest const &	request,
		Options	opts = {}
	)

Updates the settings of a specific cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.UpdateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateCluster() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::UpdateCluster	(	std::string const &	name,
		google::container::v1::ClusterUpdate const &	update,
		Options	opts = {}
	)

Updates the settings of a specific cluster.

Parameters

name	The name (project, location, cluster) of the cluster to update. Specified in the format projects/*‍/locations/*‍/clusters/*.
update	Required. A description of the update.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateMaster() [1/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::UpdateMaster	(	google::container::v1::UpdateMasterRequest const &	request,
		Options	opts = {}
	)

Updates the master for a specific cluster.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.UpdateMasterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateMaster() [2/2]

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::UpdateMaster	(	std::string const &	name,
		std::string const &	master_version,
		Options	opts = {}
	)

Updates the master for a specific cluster.

Parameters

name	The name (project, location, cluster) of the cluster to update. Specified in the format projects/*‍/locations/*‍/clusters/*.
master_version	Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: "latest": picks the highest valid Kubernetes version "1.X": picks the highest valid patch+gke.N patch in the 1.X version "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version "1.X.Y-gke.N": picks an explicit Kubernetes version "-": picks the default Kubernetes version
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateNodePool()

StatusOr< google::container::v1::Operation > google::cloud::container_v1::ClusterManagerClient::UpdateNodePool	(	google::container::v1::UpdateNodePoolRequest const &	request,
		Options	opts = {}
	)

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

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.container.v1.UpdateNodePoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

the result of the RPC. The response message type (google.container.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

Friends And Related Function Documentation

operator!=

bool operator!= ( ClusterManagerClient const &  a, ClusterManagerClient const &  b  )

friend

operator==

bool operator== ( ClusterManagerClient const &  a, ClusterManagerClient const &  b  )

friend