Google Kubernetes Engine v1 API - Class ClusterManagerClient (3.12.0)

public abstract class ClusterManagerClient

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

ClusterManager client wrapper, for convenient use.

Inheritance

object > ClusterManagerClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ClusterManagerClientImpl

Namespace

Google.Cloud.Container.V1

Assembly

Google.Cloud.Container.V1.dll

Remarks

Google Kubernetes Engine Cluster Manager v1

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ClusterManager service, which is a host of "container.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ClusterManager scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default ClusterManager scopes are:

• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual ClusterManager.ClusterManagerClient GrpcClient { get; }

The underlying gRPC ClusterManager client

Property Value
Type	Description
ClusterManagerClusterManagerClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

CancelOperation(CancelOperationRequest, CallSettings)

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

Cancels the specified operation.

Parameters
Name	Description
request	CancelOperationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
// Initialize request argument(s)
CancelOperationRequest request = new CancelOperationRequest { Name = "", };
// Make the request
clusterManagerClient.CancelOperation(request);

CancelOperation(string, CallSettings)

public virtual void CancelOperation(string name, CallSettings callSettings = null)

Cancels the specified operation.

Parameters
Name	Description
name	string The name (project, location, operation id) of the operation to cancel. Specified in the format projects/*/locations/*/operations/*.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
clusterManagerClient.CancelOperation(name);

CancelOperation(string, string, string, CallSettings)

[Obsolete]
public virtual void CancelOperation(string projectId, string zone, string operationId, CallSettings callSettings = null)

Cancels the specified operation.

Parameters
Name	Description
projectId	string Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone	string Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.
operationId	string Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

            // Create client
            ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
            // Initialize request argument(s)
            string projectId = "";
            string zone = "";
            string operationId = "";
            // Make the request
#pragma warning disable CS0612
            clusterManagerClient.CancelOperation(projectId, zone, operationId);
#pragma warning restore CS0612

CancelOperationAsync(CancelOperationRequest, CallSettings)

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

Cancels the specified operation.

Parameters
Name	Description
request	CancelOperationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
CancelOperationRequest request = new CancelOperationRequest { Name = "", };
// Make the request
await clusterManagerClient.CancelOperationAsync(request);

CancelOperationAsync(CancelOperationRequest, CancellationToken)

public virtual Task CancelOperationAsync(CancelOperationRequest request, CancellationToken cancellationToken)

Cancels the specified operation.

Parameters
Name	Description
request	CancelOperationRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
CancelOperationRequest request = new CancelOperationRequest { Name = "", };
// Make the request
await clusterManagerClient.CancelOperationAsync(request);

CancelOperationAsync(string, CallSettings)

public virtual Task CancelOperationAsync(string name, CallSettings callSettings = null)

Cancels the specified operation.

Parameters
Name	Description
name	string The name (project, location, operation id) of the operation to cancel. Specified in the format projects/*/locations/*/operations/*.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
await clusterManagerClient.CancelOperationAsync(name);

CancelOperationAsync(string, string, string, CallSettings)

[Obsolete]
public virtual Task CancelOperationAsync(string projectId, string zone, string operationId, CallSettings callSettings = null)

Cancels the specified operation.

Parameters
Name	Description
projectId	string Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone	string Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.
operationId	string Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

            // Create client
            ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
            // Initialize request argument(s)
            string projectId = "";
            string zone = "";
            string operationId = "";
            // Make the request
#pragma warning disable CS0612
            await clusterManagerClient.CancelOperationAsync(projectId, zone, operationId);
#pragma warning restore CS0612

CancelOperationAsync(string, string, string, CancellationToken)

[Obsolete]
public virtual Task CancelOperationAsync(string projectId, string zone, string operationId, CancellationToken cancellationToken)

Cancels the specified operation.

Parameters
Name	Description
projectId	string Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone	string Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.
operationId	string Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

            // Create client
            ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
            // Initialize request argument(s)
            string projectId = "";
            string zone = "";
            string operationId = "";
            // Make the request
#pragma warning disable CS0612
            await clusterManagerClient.CancelOperationAsync(projectId, zone, operationId);
#pragma warning restore CS0612

CancelOperationAsync(string, CancellationToken)

public virtual Task CancelOperationAsync(string name, CancellationToken cancellationToken)

Cancels the specified operation.

Parameters
Name	Description
name	string The name (project, location, operation id) of the operation to cancel. Specified in the format projects/*/locations/*/operations/*.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
await clusterManagerClient.CancelOperationAsync(name);

CompleteIPRotation(CompleteIPRotationRequest, CallSettings)

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

Completes master IP rotation.

Parameters
Name	Description
request	CompleteIPRotationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation	The RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
// Initialize request argument(s)
CompleteIPRotationRequest request = new CompleteIPRotationRequest { Name = "", };
// Make the request
Operation response = clusterManagerClient.CompleteIPRotation(request);

CompleteIPRotation(string, CallSettings)

public virtual Operation CompleteIPRotation(string name, CallSettings callSettings = null)

Completes master IP rotation.

Parameters
Name	Description
name	string The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format projects/*/locations/*/clusters/*.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation	The RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
Operation response = clusterManagerClient.CompleteIPRotation(name);

CompleteIPRotation(string, string, string, CallSettings)

[Obsolete]
public virtual Operation CompleteIPRotation(string projectId, string zone, string clusterId, CallSettings callSettings = null)

Completes master IP rotation.

Parameters
Name	Description
projectId	string Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone	string Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
clusterId	string Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation	The RPC response.

Example

            // Create client
            ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
            // Initialize request argument(s)
            string projectId = "";
            string zone = "";
            string clusterId = "";
            // Make the request
#pragma warning disable CS0612
            Operation response = clusterManagerClient.CompleteIPRotation(projectId, zone, clusterId);
#pragma warning restore CS0612

CompleteIPRotationAsync(CompleteIPRotationRequest, CallSettings)

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

Completes master IP rotation.

Parameters
Name	Description
request	CompleteIPRotationRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperation	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
CompleteIPRotationRequest request = new CompleteIPRotationRequest { Name = "", };
// Make the request
Operation response = await clusterManagerClient.CompleteIPRotationAsync(request);

CompleteIPRotationAsync(CompleteIPRotationRequest, CancellationToken)

public virtual Task<Operation> CompleteIPRotationAsync(CompleteIPRotationRequest request, CancellationToken cancellationToken)

Completes master IP rotation.

Parameters
Name	Description
request	CompleteIPRotationRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperation	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
CompleteIPRotationRequest request = new CompleteIPRotationRequest { Name = "", };
// Make the request
Operation response = await clusterManagerClient.CompleteIPRotationAsync(request);

CompleteIPRotationAsync(string, CallSettings)

public virtual Task<Operation> CompleteIPRotationAsync(string name, CallSettings callSettings = null)

Completes master IP rotation.

Parameters
Name	Description
name	string The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format projects/*/locations/*/clusters/*.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperation	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Operation response = await clusterManagerClient.CompleteIPRotationAsync(name);

CompleteIPRotationAsync(string, string, string, CallSettings)

[Obsolete]
public virtual Task<Operation> CompleteIPRotationAsync(string projectId, string zone, string clusterId, CallSettings callSettings = null)

Completes master IP rotation.

Parameters
Name	Description
projectId	string Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone	string Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
clusterId	string Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperation	A Task containing the RPC response.

Example

            // Create client
            ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
            // Initialize request argument(s)
            string projectId = "";
            string zone = "";
            string clusterId = "";
            // Make the request
#pragma warning disable CS0612
            Operation response = await clusterManagerClient.CompleteIPRotationAsync(projectId, zone, clusterId);
#pragma warning restore CS0612

CompleteIPRotationAsync(string, string, string, CancellationToken)

[Obsolete]
public virtual Task<Operation> CompleteIPRotationAsync(string projectId, string zone, string clusterId, CancellationToken cancellationToken)

Completes master IP rotation.

Parameters
Name	Description
projectId	string Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone	string Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
clusterId	string Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperation	A Task containing the RPC response.

Example

            // Create client
            ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
            // Initialize request argument(s)
            string projectId = "";
            string zone = "";
            string clusterId = "";
            // Make the request
#pragma warning disable CS0612
            Operation response = await clusterManagerClient.CompleteIPRotationAsync(projectId, zone, clusterId);
#pragma warning restore CS0612

CompleteIPRotationAsync(string, CancellationToken)

public virtual Task<Operation> CompleteIPRotationAsync(string name, CancellationToken cancellationToken)

Completes master IP rotation.

Parameters
Name	Description
name	string The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format projects/*/locations/*/clusters/*.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperation	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Operation response = await clusterManagerClient.CompleteIPRotationAsync(name);

CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest, CallSettings)

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

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

Parameters
Name	Description
request	CompleteNodePoolUpgradeRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
// Initialize request argument(s)
CompleteNodePoolUpgradeRequest request = new CompleteNodePoolUpgradeRequest { Name = "", };
// Make the request
clusterManagerClient.CompleteNodePoolUpgrade(request);

CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest, CallSettings)

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

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

Parameters
Name	Description
request	CompleteNodePoolUpgradeRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
CompleteNodePoolUpgradeRequest request = new CompleteNodePoolUpgradeRequest { Name = "", };
// Make the request
await clusterManagerClient.CompleteNodePoolUpgradeAsync(request);

CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest, CancellationToken)

public virtual Task CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest request, CancellationToken cancellationToken)

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

Parameters
Name	Description
request	CompleteNodePoolUpgradeRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = await ClusterManagerClient.CreateAsync();
// Initialize request argument(s)
CompleteNodePoolUpgradeRequest request = new CompleteNodePoolUpgradeRequest { Name = "", };
// Make the request
await clusterManagerClient.CompleteNodePoolUpgradeAsync(request);

Create()

public static ClusterManagerClient Create()

Synchronously creates a ClusterManagerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ClusterManagerClientBuilder.

Returns
Type	Description
ClusterManagerClient	The created ClusterManagerClient.

CreateAsync(CancellationToken)

public static Task<ClusterManagerClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a ClusterManagerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ClusterManagerClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskClusterManagerClient	The task representing the created ClusterManagerClient.

CreateCluster(CreateClusterRequest, CallSettings)

public virtual 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
Name	Description
request	CreateClusterRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation	The RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    Cluster = new Cluster(),
    Parent = "",
};
// Make the request
Operation response = clusterManagerClient.CreateCluster(request);

CreateCluster(string, Cluster, CallSettings)

public virtual Operation CreateCluster(string parent, Cluster cluster, 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
Name	Description
parent	string The parent (project and location) where the cluster will be created. Specified in the format projects/*/locations/*.
cluster	Cluster Required. A cluster resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation	The RPC response.

Example

// Create client
ClusterManagerClient clusterManagerClient = ClusterManagerClient.Create();
// Initialize request argument(s)
string parent = "";
Cluster cluster = new Cluster();
// Make the request
Operation response = clusterManagerClient.CreateCluster(parent, cluster);

CreateCluster(string, string, Cluster, CallSettings)

[Obsolete]
public virtual Operation CreateCluster(string projectId, string zone, Cluster cluster, 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
Name	Description
projectId	string Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
zone	string Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
cluster	Cluster Required. A