class ProjectsInstancesClusters extends Resource (View source)

The "clusters" collection of methods.

Typical usage is:

 $bigtableadminService = new Google\Service\BigtableAdmin(...);
 $clusters = $bigtableadminService->projects_instances_clusters;

Methods

create(string $parent, Cluster $postBody, array $optParams = [])

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. (clusters.create)

delete(string $name, array $optParams = [])

Deletes a cluster from an instance. (clusters.delete)

get(string $name, array $optParams = [])

Gets information about a cluster. (clusters.get)

listProjectsInstancesClusters(string $parent, array $optParams = [])

Lists information about clusters in an instance.

partialUpdateCluster(string $name, Cluster $postBody, array $optParams = [])

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. (clusters.partialUpdateCluster)

update(string $name, Cluster $postBody, array $optParams = [])

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. (clusters.update)

Details

Operation create(string $parent, Cluster $postBody, array $optParams = [])

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. (clusters.create)

Parameters

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}.

Cluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

BigtableadminEmpty delete(string $name, array $optParams = [])

Deletes a cluster from an instance. (clusters.delete)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

BigtableadminEmpty

Exceptions

Exception

Cluster get(string $name, array $optParams = [])

Gets information about a cluster. (clusters.get)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

Cluster

Exceptions

Exception

ListClustersResponse listProjectsInstancesClusters(string $parent, array $optParams = [])

Lists information about clusters in an instance.

(clusters.listProjectsInstancesClusters)

Parameters

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/-.

array $optParams

Optional parameters.

Return Value

ListClustersResponse

Exceptions

Exception

Operation partialUpdateCluster(string $name, Cluster $postBody, array $optParams = [])

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. (clusters.partialUpdateCluster)

Parameters

string $name

The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*.

Cluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation update(string $name, Cluster $postBody, array $optParams = [])

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. (clusters.update)

Parameters

string $name

The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*.

Cluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception