Google Kubernetes Engine v1 API - Class ClusterManager.ClusterManagerClient (3.12.0)

public class ClusterManager.ClusterManagerClient : ClientBase<ClusterManager.ClusterManagerClient>

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

Client for ClusterManager

Inheritance

object > ClientBase > ClientBaseClusterManagerClusterManagerClient > ClusterManager.ClusterManagerClient

Inherited Members

ClientBase<ClusterManager.ClusterManagerClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Container.V1

Assembly

Google.Cloud.Container.V1.dll

Constructors

ClusterManagerClient()

protected ClusterManagerClient()

Protected parameterless constructor to allow creation of test doubles.

ClusterManagerClient(CallInvoker)

public ClusterManagerClient(CallInvoker callInvoker)

Creates a new client for ClusterManager that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ClusterManagerClient(ChannelBase)

public ClusterManagerClient(ChannelBase channel)

Creates a new client for ClusterManager

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ClusterManagerClient(ClientBaseConfiguration)

protected ClusterManagerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CancelOperation(CancelOperationRequest, CallOptions)

public virtual Empty CancelOperation(CancelOperationRequest request, CallOptions options)

Cancels the specified operation.

Parameters
Name	Description
request	CancelOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

CancelOperation(CancelOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty CancelOperation(CancelOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels the specified operation.

Parameters
Name	Description
request	CancelOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

CancelOperationAsync(CancelOperationRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> CancelOperationAsync(CancelOperationRequest request, CallOptions options)

Cancels the specified operation.

Parameters
Name	Description
request	CancelOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

CancelOperationAsync(CancelOperationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> CancelOperationAsync(CancelOperationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels the specified operation.

Parameters
Name	Description
request	CancelOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

CompleteIPRotation(CompleteIPRotationRequest, CallOptions)

public virtual Operation CompleteIPRotation(CompleteIPRotationRequest request, CallOptions options)

Completes master IP rotation.

Parameters
Name	Description
request	CompleteIPRotationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CompleteIPRotation(CompleteIPRotationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CompleteIPRotation(CompleteIPRotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Completes master IP rotation.

Parameters
Name	Description
request	CompleteIPRotationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CompleteIPRotationAsync(CompleteIPRotationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CompleteIPRotationAsync(CompleteIPRotationRequest request, CallOptions options)

Completes master IP rotation.

Parameters
Name	Description
request	CompleteIPRotationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CompleteIPRotationAsync(CompleteIPRotationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CompleteIPRotationAsync(CompleteIPRotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Completes master IP rotation.

Parameters
Name	Description
request	CompleteIPRotationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest, CallOptions)

public virtual Empty CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest request, CallOptions options)

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

Parameters
Name	Description
request	CompleteNodePoolUpgradeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty CompleteNodePoolUpgrade(CompleteNodePoolUpgradeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CompleteNodePoolUpgradeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest request, CallOptions options)

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

Parameters
Name	Description
request	CompleteNodePoolUpgradeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> CompleteNodePoolUpgradeAsync(CompleteNodePoolUpgradeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CompleteNodePoolUpgradeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

CreateCluster(CreateClusterRequest, CallOptions)

public virtual Operation CreateCluster(CreateClusterRequest request, CallOptions 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	CreateClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateCluster(CreateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateCluster(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateClusterAsync(CreateClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, CallOptions 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	CreateClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateClusterAsync(CreateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateNodePool(CreateNodePoolRequest, CallOptions)

public virtual Operation CreateNodePool(CreateNodePoolRequest request, CallOptions options)

Creates a node pool for a cluster.

Parameters
Name	Description
request	CreateNodePoolRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateNodePool(CreateNodePoolRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateNodePool(CreateNodePoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a node pool for a cluster.

Parameters
Name	Description
request	CreateNodePoolRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateNodePoolAsync(CreateNodePoolRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateNodePoolAsync(CreateNodePoolRequest request, CallOptions options)

Creates a node pool for a cluster.

Parameters
Name	Description
request	CreateNodePoolRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateNodePoolAsync(CreateNodePoolRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateNodePoolAsync(CreateNodePoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a node pool for a cluster.

Parameters
Name	Description
request	CreateNodePoolRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteCluster(DeleteClusterRequest, CallOptions)

public virtual Operation DeleteCluster(DeleteClusterRequest request, CallOptions 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	DeleteClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteCluster(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteCluster(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteClusterAsync(DeleteClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, CallOptions 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	DeleteClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteClusterAsync(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteNodePool(DeleteNodePoolRequest, CallOptions)

public virtual Operation DeleteNodePool(DeleteNodePoolRequest request, CallOptions options)

Deletes a node pool from a cluster.

Parameters
Name	Description
request	DeleteNodePoolRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteNodePool(DeleteNodePoolRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteNodePool(DeleteNodePoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a node pool from a cluster.

Parameters
Name	Description
request	DeleteNodePoolRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description