You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/bigtableadmin_v2.projects.instances.clusters.html
+55Lines changed: 55 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -119,6 +119,17 @@ <h3>Method Details</h3>
119
119
The object takes the form of:
120
120
121
121
{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
122
+
"clusterConfig": { # Configuration for a cluster. # Configuration for this cluster.
123
+
"clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled.
124
+
"autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
125
+
"maxServeNodes": 42, # Required. Maximum number of nodes to scale up to.
126
+
"minServeNodes": 42, # Required. Minimum number of nodes to scale down to.
127
+
},
128
+
"autoscalingTargets": { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
129
+
"cpuUtilizationPercent": 42, # The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization).
130
+
},
131
+
},
132
+
},
122
133
"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
123
134
"encryptionConfig": { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
124
135
"kmsKeyName": "A String", # Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
@@ -192,6 +203,17 @@ <h3>Method Details</h3>
192
203
An object of the form:
193
204
194
205
{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
206
+
"clusterConfig": { # Configuration for a cluster. # Configuration for this cluster.
207
+
"clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled.
208
+
"autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
209
+
"maxServeNodes": 42, # Required. Maximum number of nodes to scale up to.
210
+
"minServeNodes": 42, # Required. Minimum number of nodes to scale down to.
211
+
},
212
+
"autoscalingTargets": { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
213
+
"cpuUtilizationPercent": 42, # The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization).
214
+
},
215
+
},
216
+
},
195
217
"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
196
218
"encryptionConfig": { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
197
219
"kmsKeyName": "A String", # Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
@@ -221,6 +243,17 @@ <h3>Method Details</h3>
221
243
{ # Response message for BigtableInstanceAdmin.ListClusters.
222
244
"clusters": [ # The list of requested clusters.
223
245
{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
246
+
"clusterConfig": { # Configuration for a cluster. # Configuration for this cluster.
247
+
"clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled.
248
+
"autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
249
+
"maxServeNodes": 42, # Required. Maximum number of nodes to scale up to.
250
+
"minServeNodes": 42, # Required. Minimum number of nodes to scale down to.
251
+
},
252
+
"autoscalingTargets": { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
253
+
"cpuUtilizationPercent": 42, # The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization).
254
+
},
255
+
},
256
+
},
224
257
"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
225
258
"encryptionConfig": { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
226
259
"kmsKeyName": "A String", # Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
@@ -262,6 +295,17 @@ <h3>Method Details</h3>
262
295
The object takes the form of:
263
296
264
297
{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
298
+
"clusterConfig": { # Configuration for a cluster. # Configuration for this cluster.
299
+
"clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled.
300
+
"autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
301
+
"maxServeNodes": 42, # Required. Maximum number of nodes to scale up to.
302
+
"minServeNodes": 42, # Required. Minimum number of nodes to scale down to.
303
+
},
304
+
"autoscalingTargets": { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
305
+
"cpuUtilizationPercent": 42, # The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization).
306
+
},
307
+
},
308
+
},
265
309
"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
266
310
"encryptionConfig": { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
267
311
"kmsKeyName": "A String", # Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
@@ -312,6 +356,17 @@ <h3>Method Details</h3>
312
356
The object takes the form of:
313
357
314
358
{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
359
+
"clusterConfig": { # Configuration for a cluster. # Configuration for this cluster.
360
+
"clusterAutoscalingConfig": { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster. Note that when creating or updating a cluster, exactly one of serve_nodes or cluster_autoscaling_config must be set. If serve_nodes is set, then serve_nodes is fixed and autoscaling is turned off. If cluster_autoscaling_config is set, then serve_nodes will be autoscaled.
361
+
"autoscalingLimits": { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
362
+
"maxServeNodes": 42, # Required. Maximum number of nodes to scale up to.
363
+
"minServeNodes": 42, # Required. Minimum number of nodes to scale down to.
364
+
},
365
+
"autoscalingTargets": { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
366
+
"cpuUtilizationPercent": 42, # The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization).
367
+
},
368
+
},
369
+
},
315
370
"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
316
371
"encryptionConfig": { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
317
372
"kmsKeyName": "A String", # Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
0 commit comments