public final class CreateClusterRequest
Parameters for creating a new Bigtable cluster.
A cluster represents the actual Cloud Bigtable service. Each cluster belongs to a single Cloud Bigtable instance. When your application sends requests to a Cloud Bigtable instance, those requests are actually handled by one of the clusters in the instance.
Each cluster is located in a single zone. An instance's clusters must be in unique zones that are within the same region. For example, if the first cluster is in us-east1-b, then us-east1-c is a valid zone for the second cluster. For a list of zones and regions where Cloud Bigtable is available, see Cloud Bigtable Locations.
Examples:
// Small production instance:
CreateClusterRequest clusterRequest = CreateClusterRequest.of("my-existing-instance", "my-cluster")
.setZone("us-east1-c")
.setServeNodes(3)
.setStorageType(StorageType.SSD);
Methods
of(String instanceId, String clusterId)
public static CreateClusterRequest of(String instanceId, String clusterId)
Builds a new request to create a new cluster to the specified instance with the specified cluster id.
Name | Description |
instanceId | String |
clusterId | String |
Type | Description |
CreateClusterRequest |
setKmsKeyName(String kmsKeyName)
public CreateClusterRequest setKmsKeyName(String kmsKeyName)
Sets the Google Cloud Key Management Service (KMS) key for a CMEK-protected Bigtable. This
requires the full resource name of the Cloud KMS key, in the format
projects/{key_project_id}/locations/{location}/keyRings/{ring_name}/cryptoKeys/{key_name}
Name | Description |
kmsKeyName | String |
Type | Description |
CreateClusterRequest |
setServeNodes(int numNodes)
public CreateClusterRequest setServeNodes(int numNodes)
Sets the number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
Name | Description |
numNodes | int |
Type | Description |
CreateClusterRequest |
setStorageType(StorageType storageType)
public CreateClusterRequest setStorageType(StorageType storageType)
Sets the type of storage used by this cluster to serve its parent instance's tables. Defaults
to SSD
.
Name | Description |
storageType | StorageType |
Type | Description |
CreateClusterRequest |
setZone(String zone)
public CreateClusterRequest setZone(String zone)
Sets the zone where the new cluster will be located. Must be different from the existing cluster.
Name | Description |
zone | String |
Type | Description |
CreateClusterRequest |
toProto(String projectId)
public CreateClusterRequest toProto(String projectId)
Creates the request protobuf. This method is considered an internal implementation detail and not meant to be used by applications.
Name | Description |
projectId | String |
Type | Description |
CreateClusterRequest |