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.
Constructors
ClusterManagerClient(ClusterManagerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ClusterManagerClient const &
|
ClusterManagerClient(ClusterManagerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ClusterManagerClient &&
|
ClusterManagerClient(std::shared_ptr< ClusterManagerConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ClusterManagerConnection >
|
opts |
Options
|
Operators
operator=(ClusterManagerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ClusterManagerClient const &
|
Returns | |
---|---|
Type | Description |
ClusterManagerClient & |
operator=(ClusterManagerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ClusterManagerClient &&
|
Returns | |
---|---|
Type | Description |
ClusterManagerClient & |
Functions
ListClusters(std::string const &, Options)
Lists all clusters owned by a project in either the specified zone or all zones.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
The parent (project and location) where the clusters will be listed. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::ListClustersResponse > |
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 |
ListClusters(google::container::v1::ListClustersRequest const &, Options)
Lists all clusters owned by a project in either the specified zone or all zones.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::ListClustersRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::ListClustersResponse > |
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 |
GetCluster(std::string const &, Options)
Gets the details of a specific cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster) of the cluster to retrieve. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Cluster > |
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 |
GetCluster(google::container::v1::GetClusterRequest const &, Options)
Gets the details of a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::GetClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Cluster > |
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 |
CreateCluster(std::string const &, google::container::v1::Cluster const &, Options)
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 | |
---|---|
Name | Description |
parent |
std::string const &
The parent (project and location) where the cluster will be created. Specified in the format |
cluster |
google::container::v1::Cluster const &
Required. A cluster resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
CreateCluster(google::container::v1::CreateClusterRequest const &, Options)
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 | |
---|---|
Name | Description |
request |
google::container::v1::CreateClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
UpdateCluster(std::string const &, google::container::v1::ClusterUpdate const &, Options)
Updates the settings of a specific cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster) of the cluster to update. Specified in the format |
update |
google::container::v1::ClusterUpdate const &
Required. A description of the update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
UpdateCluster(google::container::v1::UpdateClusterRequest const &, Options)
Updates the settings of a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::UpdateClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
UpdateNodePool(google::container::v1::UpdateNodePoolRequest const &, Options)
Updates the version and/or image type for the specified node pool.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::UpdateNodePoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetNodePoolAutoscaling(google::container::v1::SetNodePoolAutoscalingRequest const &, Options)
Sets the autoscaling settings for the specified node pool.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetNodePoolAutoscalingRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetLoggingService(std::string const &, std::string const &, Options)
Sets the logging service for a specific cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster) of the cluster to set logging. Specified in the format |
logging_service |
std::string const &
Required. The logging service the cluster should use to write logs. Currently available options:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetLoggingService(google::container::v1::SetLoggingServiceRequest const &, Options)
Sets the logging service for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetLoggingServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetMonitoringService(std::string const &, std::string const &, Options)
Sets the monitoring service for a specific cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster) of the cluster to set monitoring. Specified in the format |
monitoring_service |
std::string const &
Required. The monitoring service the cluster should use to write metrics. Currently available options:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetMonitoringService(google::container::v1::SetMonitoringServiceRequest const &, Options)
Sets the monitoring service for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetMonitoringServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetAddonsConfig(std::string const &, google::container::v1::AddonsConfig const &, Options)
Sets the addons for a specific cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster) of the cluster to set addons. Specified in the format |
addons_config |
google::container::v1::AddonsConfig const &
Required. The desired configurations for the various addons available to run in the cluster. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetAddonsConfig(google::container::v1::SetAddonsConfigRequest const &, Options)
Sets the addons for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetAddonsConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetLocations(std::string const &, std::vector< std::string > const &, Options)
Sets the locations for a specific cluster.
Deprecated. Use projects.locations.clusters.update instead.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster) of the cluster to set locations. Specified in the format |
locations |
std::vector< std::string > const &
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. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetLocations(google::container::v1::SetLocationsRequest const &, Options)
Sets the locations for a specific cluster.
Deprecated. Use projects.locations.clusters.update instead.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetLocationsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
UpdateMaster(std::string const &, std::string const &, Options)
Updates the master for a specific cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster) of the cluster to update. Specified in the format |
master_version |
std::string const &
Required. The Kubernetes version to change the master to.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
UpdateMaster(google::container::v1::UpdateMasterRequest const &, Options)
Updates the master for a specific cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::UpdateMasterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetMasterAuth(google::container::v1::SetMasterAuthRequest const &, Options)
Sets master auth materials.
Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetMasterAuthRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
DeleteCluster(std::string const &, Options)
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 | Description |
name |
std::string const &
The name (project, location, cluster) of the cluster to delete. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
DeleteCluster(google::container::v1::DeleteClusterRequest const &, Options)
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 | Description |
request |
google::container::v1::DeleteClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
ListOperations(google::container::v1::ListOperationsRequest const &, Options)
Lists all operations in a project in a specific zone or all zones.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::ListOperationsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::ListOperationsResponse > |
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 |
GetOperation(std::string const &, Options)
Gets the specified operation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, operation id) of the operation to get. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
GetOperation(google::container::v1::GetOperationRequest const &, Options)
Gets the specified operation.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
CancelOperation(std::string const &, Options)
Cancels the specified operation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, operation id) of the operation to cancel. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::container::v1::CancelOperationRequest const &, Options)
Cancels the specified operation.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
GetServerConfig(std::string const &, Options)
Returns configuration info about the Google Kubernetes Engine service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project and location) of the server config to get, specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::ServerConfig > |
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 |
GetServerConfig(google::container::v1::GetServerConfigRequest const &, Options)
Returns configuration info about the Google Kubernetes Engine service.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::GetServerConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::ServerConfig > |
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 |
GetJSONWebKeys(google::container::v1::GetJSONWebKeysRequest const &, Options)
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 | |
---|---|
Name | Description |
request |
google::container::v1::GetJSONWebKeysRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::GetJSONWebKeysResponse > |
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 |
ListNodePools(std::string const &, Options)
Lists the node pools for a cluster.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
The parent (project, location, cluster name) where the node pools will be listed. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::ListNodePoolsResponse > |
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 |
ListNodePools(google::container::v1::ListNodePoolsRequest const &, Options)
Lists the node pools for a cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::ListNodePoolsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::ListNodePoolsResponse > |
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 |
GetNodePool(std::string const &, Options)
Retrieves the requested node pool.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::NodePool > |
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 |
GetNodePool(google::container::v1::GetNodePoolRequest const &, Options)
Retrieves the requested node pool.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::GetNodePoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::NodePool > |
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 |
CreateNodePool(std::string const &, google::container::v1::NodePool const &, Options)
Creates a node pool for a cluster.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
The parent (project, location, cluster name) where the node pool will be created. Specified in the format |
node_pool |
google::container::v1::NodePool const &
Required. The node pool to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
CreateNodePool(google::container::v1::CreateNodePoolRequest const &, Options)
Creates a node pool for a cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::CreateNodePoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
DeleteNodePool(std::string const &, Options)
Deletes a node pool from a cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
DeleteNodePool(google::container::v1::DeleteNodePoolRequest const &, Options)
Deletes a node pool from a cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::DeleteNodePoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
CompleteNodePoolUpgrade(google::container::v1::CompleteNodePoolUpgradeRequest const &, Options)
CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::CompleteNodePoolUpgradeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
RollbackNodePoolUpgrade(std::string const &, Options)
Rolls back a previously Aborted or Failed NodePool upgrade.
This makes no changes if the last upgrade successfully completed.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
RollbackNodePoolUpgrade(google::container::v1::RollbackNodePoolUpgradeRequest const &, Options)
Rolls back a previously Aborted or Failed NodePool upgrade.
This makes no changes if the last upgrade successfully completed.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::RollbackNodePoolUpgradeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetNodePoolManagement(google::container::v1::SetNodePoolManagementRequest const &, Options)
Sets the NodeManagement options for a node pool.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetNodePoolManagementRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetLabels(google::container::v1::SetLabelsRequest const &, Options)
Sets labels on a cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetLabelsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetLegacyAbac(std::string const &, bool, Options)
Enables or disables the ABAC authorization mechanism on a cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format |
enabled |
bool
Required. Whether ABAC authorization will be enabled in the cluster. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetLegacyAbac(google::container::v1::SetLegacyAbacRequest const &, Options)
Enables or disables the ABAC authorization mechanism on a cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetLegacyAbacRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
StartIPRotation(std::string const &, Options)
Starts master IP rotation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
StartIPRotation(google::container::v1::StartIPRotationRequest const &, Options)
Starts master IP rotation.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::StartIPRotationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
CompleteIPRotation(std::string const &, Options)
Completes master IP rotation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
CompleteIPRotation(google::container::v1::CompleteIPRotationRequest const &, Options)
Completes master IP rotation.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::CompleteIPRotationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetNodePoolSize(google::container::v1::SetNodePoolSizeRequest const &, Options)
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 | |
---|---|
Name | Description |
request |
google::container::v1::SetNodePoolSizeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetNetworkPolicy(std::string const &, google::container::v1::NetworkPolicy const &, Options)
Enables or disables Network Policy for a cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster name) of the cluster to set networking policy. Specified in the format |
network_policy |
google::container::v1::NetworkPolicy const &
Required. Configuration options for the NetworkPolicy feature. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetNetworkPolicy(google::container::v1::SetNetworkPolicyRequest const &, Options)
Enables or disables Network Policy for a cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetNetworkPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetMaintenancePolicy(std::string const &, std::string const &, std::string const &, google::container::v1::MaintenancePolicy const &, Options)
Sets the maintenance policy for a cluster.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. The Google Developers Console project ID or project number. |
zone |
std::string const &
Required. The name of the Google Compute Engine zone in which the cluster resides. |
cluster_id |
std::string const &
Required. The name of the cluster to update. |
maintenance_policy |
google::container::v1::MaintenancePolicy const &
Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetMaintenancePolicy(std::string const &, google::container::v1::MaintenancePolicy const &, Options)
Sets the maintenance policy for a cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format |
maintenance_policy |
google::container::v1::MaintenancePolicy const &
Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
SetMaintenancePolicy(google::container::v1::SetMaintenancePolicyRequest const &, Options)
Sets the maintenance policy for a cluster.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::SetMaintenancePolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::Operation > |
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 |
ListUsableSubnetworks(google::container::v1::ListUsableSubnetworksRequest, Options)
Lists subnetworks that are usable for creating clusters in a project.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::ListUsableSubnetworksRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::container::v1::UsableSubnetwork > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CheckAutopilotCompatibility(google::container::v1::CheckAutopilotCompatibilityRequest const &, Options)
Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.
Parameters | |
---|---|
Name | Description |
request |
google::container::v1::CheckAutopilotCompatibilityRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::container::v1::CheckAutopilotCompatibilityResponse > |
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 |