Class ProjectsResource.InstancesResource.ClustersResource

The "clusters" collection of methods.

Inheritance

object

ProjectsResource.InstancesResource.ClustersResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.BigtableAdmin.v2

Assembly: Google.Apis.BigtableAdmin.v2.dll

Syntax

public class ProjectsResource.InstancesResource.ClustersResource

Constructors

ClustersResource(IClientService)

Constructs a new resource.

Declaration

public ClustersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Backups

Gets the Backups resource.

Declaration

public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource Backups { get; }

Property Value

Type	Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource

HotTablets

Gets the HotTablets resource.

Declaration

public virtual ProjectsResource.InstancesResource.ClustersResource.HotTabletsResource HotTablets { get; }

Property Value

Type	Description
ProjectsResource.InstancesResource.ClustersResource.HotTabletsResource

Methods

Create(Cluster, string)

Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Declaration

public virtual ProjectsResource.InstancesResource.ClustersResource.CreateRequest Create(Cluster body, string parent)

Parameters

Type	Name	Description
Cluster	body	The body of the request.
string	parent	Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

Returns

Type	Description
ProjectsResource.InstancesResource.ClustersResource.CreateRequest

Delete(string)

Deletes a cluster from an instance.

Declaration

public virtual ProjectsResource.InstancesResource.ClustersResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns

Type	Description
ProjectsResource.InstancesResource.ClustersResource.DeleteRequest

Get(string)

Gets information about a cluster.

Declaration

public virtual ProjectsResource.InstancesResource.ClustersResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns

Type	Description
ProjectsResource.InstancesResource.ClustersResource.GetRequest

List(string)

Lists information about clusters in an instance.

Declaration

public virtual ProjectsResource.InstancesResource.ClustersResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

Returns

Type	Description
ProjectsResource.InstancesResource.ClustersResource.ListRequest

PartialUpdateCluster(Cluster, string)

Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Declaration

public virtual ProjectsResource.InstancesResource.ClustersResource.PartialUpdateClusterRequest PartialUpdateCluster(Cluster body, string name)

Parameters

Type	Name	Description
Cluster	body	The body of the request.
string	name	The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*.

Returns

Type	Description
ProjectsResource.InstancesResource.ClustersResource.PartialUpdateClusterRequest

Update(Cluster, string)

Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

Declaration

public virtual ProjectsResource.InstancesResource.ClustersResource.UpdateRequest Update(Cluster body, string name)

Parameters

Type	Name	Description
Cluster	body	The body of the request.
string	name	The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*.

Returns

Type	Description
ProjectsResource.InstancesResource.ClustersResource.UpdateRequest