Google Kubernetes Engine v1 API - Class ClusterManager.ClusterManagerBase (3.22.0)

[BindServiceMethod(typeof(ClusterManager), "BindService")]
public abstract class ClusterManager.ClusterManagerBase

Reference documentation and code samples for the Google Kubernetes Engine v1 API class ClusterManager.ClusterManagerBase.

Base class for server-side implementations of ClusterManager

Inheritance

object > ClusterManager.ClusterManagerBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Container.V1

Assembly

Google.Cloud.Container.V1.dll

Methods

CancelOperation(CancelOperationRequest, ServerCallContext)

public virtual Task<Empty> CancelOperation(CancelOperationRequest request, ServerCallContext context)

Cancels the specified operation.

Parameters
Name	Description
`request`	`CancelOperationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

CheckAutopilotCompatibility(CheckAutopilotCompatibilityRequest, ServerCallContext)

public virtual Task<CheckAutopilotCompatibilityResponse> CheckAutopilotCompatibility(CheckAutopilotCompatibilityRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`CheckAutopilotCompatibilityRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskCheckAutopilotCompatibilityResponse`	The response to send back to the client (wrapped by a task).

CompleteIPRotation(CompleteIPRotationRequest, ServerCallContext)

public virtual Task<Operation> CompleteIPRotation(CompleteIPRotationRequest request, ServerCallContext context)

Completes master IP rotation.

Parameters
Name	Description
`request`	`CompleteIPRotationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest, ServerCallContext)

public virtual Task<Empty> CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`CompleteNodePoolUpgradeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

CreateCluster(CreateClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateCluster(CreateClusterRequest request, ServerCallContext context)

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`	`CreateClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateNodePool(CreateNodePoolRequest, ServerCallContext)

public virtual Task<Operation> CreateNodePool(CreateNodePoolRequest request, ServerCallContext context)

Creates a node pool for a cluster.

Parameters
Name	Description
`request`	`CreateNodePoolRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteCluster(DeleteClusterRequest, ServerCallContext)

public virtual Task<Operation> DeleteCluster(DeleteClusterRequest request, ServerCallContext context)

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`	`DeleteClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteNodePool(DeleteNodePoolRequest, ServerCallContext)

public virtual Task<Operation> DeleteNodePool(DeleteNodePoolRequest request, ServerCallContext context)

Deletes a node pool from a cluster.

Parameters
Name	Description
`request`	`DeleteNodePoolRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetCluster(GetClusterRequest, ServerCallContext)

public virtual Task<Cluster> GetCluster(GetClusterRequest request, ServerCallContext context)

Gets the details of a specific cluster.

Parameters
Name	Description
`request`	`GetClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskCluster`	The response to send back to the client (wrapped by a task).

GetJSONWebKeys(GetJSONWebKeysRequest, ServerCallContext)

public virtual Task<GetJSONWebKeysResponse> GetJSONWebKeys(GetJSONWebKeysRequest request, ServerCallContext context)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
Name	Description
`request`	`GetJSONWebKeysRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskGetJSONWebKeysResponse`	The response to send back to the client (wrapped by a task).

GetNodePool(GetNodePoolRequest, ServerCallContext)

public virtual Task<NodePool> GetNodePool(GetNodePoolRequest request, ServerCallContext context)

Retrieves the requested node pool.

Parameters
Name	Description
`request`	`GetNodePoolRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskNodePool`	The response to send back to the client (wrapped by a task).

GetOperation(GetOperationRequest, ServerCallContext)

public virtual Task<Operation> GetOperation(GetOperationRequest request, ServerCallContext context)

Gets the specified operation.

Parameters
Name	Description
`request`	`GetOperationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetServerConfig(GetServerConfigRequest, ServerCallContext)

public virtual Task<ServerConfig> GetServerConfig(GetServerConfigRequest request, ServerCallContext context)

Returns configuration info about the Google Kubernetes Engine service.

Parameters
Name	Description
`request`	`GetServerConfigRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskServerConfig`	The response to send back to the client (wrapped by a task).

ListClusters(ListClustersRequest, ServerCallContext)

public virtual Task<ListClustersResponse> ListClusters(ListClustersRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`ListClustersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListClustersResponse`	The response to send back to the client (wrapped by a task).

ListNodePools(ListNodePoolsRequest, ServerCallContext)

public virtual Task<ListNodePoolsResponse> ListNodePools(ListNodePoolsRequest request, ServerCallContext context)

Lists the node pools for a cluster.

Parameters
Name	Description
`request`	`ListNodePoolsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListNodePoolsResponse`	The response to send back to the client (wrapped by a task).

ListOperations(ListOperationsRequest, ServerCallContext)

public virtual Task<ListOperationsResponse> ListOperations(ListOperationsRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`ListOperationsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListOperationsResponse`	The response to send back to the client (wrapped by a task).

ListUsableSubnetworks(ListUsableSubnetworksRequest, ServerCallContext)

public virtual Task<ListUsableSubnetworksResponse> ListUsableSubnetworks(ListUsableSubnetworksRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`ListUsableSubnetworksRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListUsableSubnetworksResponse`	The response to send back to the client (wrapped by a task).

RollbackNodePoolUpgrade(RollbackNodePoolUpgradeRequest, ServerCallContext)

public virtual Task<Operation> RollbackNodePoolUpgrade(RollbackNodePoolUpgradeRequest request, ServerCallContext context)

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Parameters
Name	Description
`request`	`RollbackNodePoolUpgradeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetAddonsConfig(SetAddonsConfigRequest, ServerCallContext)

public virtual Task<Operation> SetAddonsConfig(SetAddonsConfigRequest request, ServerCallContext context)

Sets the addons for a specific cluster.

Parameters
Name	Description
`request`	`SetAddonsConfigRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetLabels(SetLabelsRequest, ServerCallContext)

public virtual Task<Operation> SetLabels(SetLabelsRequest request, ServerCallContext context)

Sets labels on a cluster.

Parameters
Name	Description
`request`	`SetLabelsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetLegacyAbac(SetLegacyAbacRequest, ServerCallContext)

public virtual Task<Operation> SetLegacyAbac(SetLegacyAbacRequest request, ServerCallContext context)

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters
Name	Description
`request`	`SetLegacyAbacRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetLocations(SetLocationsRequest, ServerCallContext)

[Obsolete]
public virtual Task<Operation> SetLocations(SetLocationsRequest request, ServerCallContext context)

Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.

Parameters
Name	Description
`request`	`SetLocationsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetLoggingService(SetLoggingServiceRequest, ServerCallContext)

public virtual Task<Operation> SetLoggingService(SetLoggingServiceRequest request, ServerCallContext context)

Sets the logging service for a specific cluster.

Parameters
Name	Description
`request`	`SetLoggingServiceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetMaintenancePolicy(SetMaintenancePolicyRequest, ServerCallContext)

public virtual Task<Operation> SetMaintenancePolicy(SetMaintenancePolicyRequest request, ServerCallContext context)

Sets the maintenance policy for a cluster.

Parameters
Name	Description
`request`	`SetMaintenancePolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetMasterAuth(SetMasterAuthRequest, ServerCallContext)

public virtual Task<Operation> SetMasterAuth(SetMasterAuthRequest request, ServerCallContext context)

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`	`SetMasterAuthRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetMonitoringService(SetMonitoringServiceRequest, ServerCallContext)

public virtual Task<Operation> SetMonitoringService(SetMonitoringServiceRequest request, ServerCallContext context)

Sets the monitoring service for a specific cluster.

Parameters
Name	Description
`request`	`SetMonitoringServiceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetNetworkPolicy(SetNetworkPolicyRequest, ServerCallContext)

public virtual Task<Operation> SetNetworkPolicy(SetNetworkPolicyRequest request, ServerCallContext context)

Enables or disables Network Policy for a cluster.

Parameters
Name	Description
`request`	`SetNetworkPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetNodePoolAutoscaling(SetNodePoolAutoscalingRequest, ServerCallContext)

public virtual Task<Operation> SetNodePoolAutoscaling(SetNodePoolAutoscalingRequest request, ServerCallContext context)

Sets the autoscaling settings for the specified node pool.

Parameters
Name	Description
`request`	`SetNodePoolAutoscalingRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetNodePoolManagement(SetNodePoolManagementRequest, ServerCallContext)

public virtual Task<Operation> SetNodePoolManagement(SetNodePoolManagementRequest request, ServerCallContext context)

Sets the NodeManagement options for a node pool.

Parameters
Name	Description
`request`	`SetNodePoolManagementRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetNodePoolSize(SetNodePoolSizeRequest, ServerCallContext)

public virtual Task<Operation> SetNodePoolSize(SetNodePoolSizeRequest request, ServerCallContext context)

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][google.container.v1.NodePool.locations].

Parameters
Name	Description
`request`	`SetNodePoolSizeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

StartIPRotation(StartIPRotationRequest, ServerCallContext)

public virtual Task<Operation> StartIPRotation(StartIPRotationRequest request, ServerCallContext context)

Starts master IP rotation.

Parameters
Name	Description
`request`	`StartIPRotationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateCluster(UpdateClusterRequest, ServerCallContext)

public virtual Task<Operation> UpdateCluster(UpdateClusterRequest request, ServerCallContext context)

Updates the settings of a specific cluster.

Parameters
Name	Description
`request`	`UpdateClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateMaster(UpdateMasterRequest, ServerCallContext)

public virtual Task<Operation> UpdateMaster(UpdateMasterRequest request, ServerCallContext context)

Updates the master for a specific cluster.

Parameters
Name	Description
`request`	`UpdateMasterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateNodePool(UpdateNodePoolRequest, ServerCallContext)

public virtual Task<Operation> UpdateNodePool(UpdateNodePoolRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`UpdateNodePoolRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).