Google Kubernetes Engine v1 API - Class ClusterManagerClientImpl (3.6.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ClusterManagerClientImpl : ClusterManagerClient

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

ClusterManager client wrapper implementation, for convenient use.

Inheritance

Object > ClusterManagerClient > ClusterManagerClientImpl

Namespace

Google.Cloud.Container.V1

Assembly

Google.Cloud.Container.V1.dll

Remarks

Google Kubernetes Engine Cluster Manager v1

Constructors

ClusterManagerClientImpl(ClusterManager.ClusterManagerClient, ClusterManagerSettings, ILogger)

public ClusterManagerClientImpl(ClusterManager.ClusterManagerClient grpcClient, ClusterManagerSettings settings, ILogger logger)

Constructs a client wrapper for the ClusterManager service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientClusterManager.ClusterManagerClient

The underlying gRPC client.

settingsClusterManagerSettings

The base ClusterManagerSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override ClusterManager.ClusterManagerClient GrpcClient { get; }

The underlying gRPC ClusterManager client

Property Value
TypeDescription
ClusterManager.ClusterManagerClient
Overrides

Methods

CancelOperation(CancelOperationRequest, CallSettings)

public override void CancelOperation(CancelOperationRequest request, CallSettings callSettings = null)

Cancels the specified operation.

Parameters
NameDescription
requestCancelOperationRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

CancelOperationAsync(CancelOperationRequest, CallSettings)

public override Task CancelOperationAsync(CancelOperationRequest request, CallSettings callSettings = null)

Cancels the specified operation.

Parameters
NameDescription
requestCancelOperationRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

CompleteIPRotation(CompleteIPRotationRequest, CallSettings)

public override Operation CompleteIPRotation(CompleteIPRotationRequest request, CallSettings callSettings = null)

Completes master IP rotation.

Parameters
NameDescription
requestCompleteIPRotationRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Overrides

CompleteIPRotationAsync(CompleteIPRotationRequest, CallSettings)

public override Task<Operation> CompleteIPRotationAsync(CompleteIPRotationRequest request, CallSettings callSettings = null)

Completes master IP rotation.

Parameters
NameDescription
requestCompleteIPRotationRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation>

A Task containing the RPC response.

Overrides

CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest, CallSettings)

public override void CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCompleteNodePoolUpgradeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest, CallSettings)

public override Task CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCompleteNodePoolUpgradeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

CreateCluster(CreateClusterRequest, CallSettings)

public override Operation CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Overrides

CreateClusterAsync(CreateClusterRequest, CallSettings)

public override Task<Operation> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)

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
NameDescription
requestCreateClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation>

A Task containing the RPC response.

Overrides

CreateNodePool(CreateNodePoolRequest, CallSettings)

public override Operation CreateNodePool(CreateNodePoolRequest request, CallSettings callSettings = null)

Creates a node pool for a cluster.

Parameters
NameDescription
requestCreateNodePoolRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Overrides

CreateNodePoolAsync(CreateNodePoolRequest, CallSettings)

public override Task<Operation> CreateNodePoolAsync(CreateNodePoolRequest request, CallSettings callSettings = null)

Creates a node pool for a cluster.

Parameters
NameDescription
requestCreateNodePoolRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation>

A Task containing the RPC response.

Overrides

DeleteCluster(DeleteClusterRequest, CallSettings)

public override Operation DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)

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
NameDescription
requestDeleteClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Overrides

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

public override Task<Operation> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)

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
NameDescription
requestDeleteClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation>

A Task containing the RPC response.

Overrides

DeleteNodePool(DeleteNodePoolRequest, CallSettings)

public override Operation DeleteNodePool(DeleteNodePoolRequest request, CallSettings callSettings = null)

Deletes a node pool from a cluster.

Parameters
NameDescription
requestDeleteNodePoolRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Overrides

DeleteNodePoolAsync(DeleteNodePoolRequest, CallSettings)

public override Task<Operation> DeleteNodePoolAsync(DeleteNodePoolRequest request, CallSettings callSettings = null)

Deletes a node pool from a cluster.

Parameters
NameDescription
requestDeleteNodePoolRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation>

A Task containing the RPC response.

Overrides

GetCluster(GetClusterRequest, CallSettings)

public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)

Gets the details of a specific cluster.

Parameters
NameDescription
requestGetClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Cluster

The RPC response.

Overrides

GetClusterAsync(GetClusterRequest, CallSettings)

public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)

Gets the details of a specific cluster.

Parameters
NameDescription
requestGetClusterRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Cluster>

A Task containing the RPC response.

Overrides

GetJSONWebKeys(GetJSONWebKeysRequest, CallSettings)

public override GetJSONWebKeysResponse GetJSONWebKeys(GetJSONWebKeysRequest request, CallSettings callSettings = null)

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
NameDescription
requestGetJSONWebKeysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GetJSONWebKeysResponse

The RPC response.

Overrides

GetJSONWebKeysAsync(GetJSONWebKeysRequest, CallSettings)

public override Task<GetJSONWebKeysResponse> GetJSONWebKeysAsync(GetJSONWebKeysRequest request, CallSettings callSettings = null)

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
NameDescription
requestGetJSONWebKeysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GetJSONWebKeysResponse>

A Task containing the RPC response.

Overrides

GetNodePool(GetNodePoolRequest, CallSettings)

public override NodePool GetNodePool(GetNodePoolRequest request, CallSettings callSettings = null)

Retrieves the requested node pool.

Parameters
NameDescription
requestGetNodePoolRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NodePool

The RPC response.

Overrides

GetNodePoolAsync(GetNodePoolRequest, CallSettings)

public override Task<NodePool> GetNodePoolAsync(GetNodePoolRequest request, CallSettings callSettings = null)

Retrieves the requested node pool.

Parameters
NameDescription
requestGetNodePoolRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NodePool>

A Task containing the RPC response.

Overrides

GetOperation(GetOperationRequest, CallSettings)

public override Operation GetOperation(GetOperationRequest request, CallSettings callSettings = null)

Gets the specified operation.

Parameters
NameDescription
requestGetOperationRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation

The RPC response.

Overrides

GetOperationAsync(GetOperationRequest, CallSettings)

public override Task<Operation> GetOperationAsync(GetOperationRequest request, CallSettings callSettings = null)

Gets the specified operation.

Parameters
NameDescription
requestGetOperationRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation>

A Task containing the RPC response.

Overrides

GetServerConfig(GetServerConfigRequest, CallSettings)

public override ServerConfig GetServerConfig(GetServerConfigRequest request, CallSettings callSettings = null)

Returns configuration info about the Google Kubernetes Engine service.

Parameters
NameDescription
requestGetServerConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ServerConfig

The RPC response.

Overrides

GetServerConfigAsync(GetServerConfigRequest, CallSettings)

public override Task<ServerConfig> GetServerConfigAsync(GetServerConfigRequest request, CallSettings callSettings = null)

Returns configuration info about the Google Kubernetes Engine service.

Parameters
NameDescription
requestGetServerConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ServerConfig>

A Task containing the RPC response.

Overrides

ListClusters(ListClustersRequest, CallSettings)

public override ListClustersResponse ListClusters(ListClustersRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListClustersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListClustersResponse

The RPC response.

Overrides

ListClustersAsync(ListClustersRequest, CallSettings)

public override Task<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListClustersRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ListClustersResponse>

A Task containing the RPC response.

Overrides

ListNodePools(ListNodePoolsRequest, CallSettings)

public override ListNodePoolsResponse ListNodePools(ListNodePoolsRequest request, CallSettings callSettings = null)

Lists the node pools for a cluster.

Parameters
NameDescription
requestListNodePoolsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListNodePoolsResponse

The RPC response.

Overrides

ListNodePoolsAsync(ListNodePoolsRequest, CallSettings)

public override Task<ListNodePoolsResponse> ListNodePoolsAsync(ListNodePoolsRequest request, CallSettings callSettings = null)

Lists the node pools for a cluster.

Parameters
NameDescription
requestListNodePoolsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ListNodePoolsResponse>

A Task containing the RPC response.

Overrides

ListOperations(ListOperationsRequest, CallSettings)

public override ListOperationsResponse ListOperations(ListOperationsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListOperationsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListOperationsResponse

The RPC response.

Overrides

ListOperationsAsync(ListOperationsRequest, CallSettings)

public override Task<ListOperationsResponse> ListOperationsAsync(ListOperationsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListOperationsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ListOperationsResponse>

A Task containing the RPC response.

Overrides

ListUsableSubnetworks(ListUsableSubnetworksRequest, CallSettings)

public override PagedEnumerable<ListUsableSubnetworksResponse, UsableSubnetwork> ListUsableSubnetworks(ListUsableSubnetworksRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListUsableSubnetworksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListUsableSubnetworksResponse, UsableSubnetwork>

A pageable sequence of UsableSubnetwork resources.

Overrides

ListUsableSubnetworksAsync(ListUsableSubnetworksRequest, CallSettings)

public override PagedAsyncEnumerable<ListUsableSubnetworksResponse, UsableSubnetwork> ListUsableSubnetworksAsync(ListUsableSubnetworksRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListUsableSubnetworksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListUsableSubnetworksResponse, UsableSubnetwork>

A pageable asynchronous sequence of UsableSubnetwork resources.

Overrides