Debian Codegraph @

docs/dyn/bigtableadmin_v2.projects.instances.clusters.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.clusters.html">clusters</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="bigtableadmin_v2.projects.instances.clusters.backups.html">backups()</a></code>
79 </p>
80 <p class="firstline">Returns the backups Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="bigtableadmin_v2.projects.instances.clusters.hotTablets.html">hotTablets()</a></code>
84 </p>
85 <p class="firstline">Returns the hotTablets Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="bigtableadmin_v2.projects.instances.clusters.memoryLayers.html">memoryLayers()</a></code>
89 </p>
90 <p class="firstline">Returns the memoryLayers Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="#close">close()</a></code></p>
94 <p class="firstline">Close httplib2 connections.</p>
95 <p class="toc_element">
96 <code><a href="#create">create(parent, body=None, clusterId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">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.</p>
98 <p class="toc_element">
99 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
100 <p class="firstline">Deletes a cluster from an instance.</p>
101 <p class="toc_element">
102 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
103 <p class="firstline">Gets information about a cluster.</p>
104 <p class="toc_element">
105 <code><a href="#getMemoryLayer">getMemoryLayer(name, x__xgafv=None)</a></code></p>
106 <p class="firstline">Gets information about the memory layer of a cluster.</p>
107 <p class="toc_element">
108 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Lists information about clusters in an instance.</p>
110 <p class="toc_element">
111 <code><a href="#list_next">list_next()</a></code></p>
112 <p class="firstline">Retrieves the next page of results.</p>
113 <p class="toc_element">
114 <code><a href="#partialUpdateCluster">partialUpdateCluster(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">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.</p>
116 <p class="toc_element">
117 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">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.</p>
119 <h3>Method Details</h3>
120 <div class="method">
121 <code class="details" id="close">close()</code>
122 <pre>Close httplib2 connections.</pre>
123 </div>
124
125 <div class="method">
126 <code class="details" id="create">create(parent, body=None, clusterId=None, x__xgafv=None)</code>
127 <pre>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.
128
129 Args:
130 parent: string, Required. The unique name of the instance in which to create the new cluster. Values are of the form `projects/{project}/instances/{instance}`. (required)
131 body: object, The request body.
132 The object takes the form of:
133
134 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
135 &quot;clusterConfig&quot;: { # Configuration for a cluster. # Configuration for this cluster.
136 &quot;clusterAutoscalingConfig&quot;: { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster.
137 &quot;autoscalingLimits&quot;: { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
138 &quot;maxServeNodes&quot;: 42, # Required. Maximum number of nodes to scale up to.
139 &quot;minServeNodes&quot;: 42, # Required. Minimum number of nodes to scale down to.
140 },
141 &quot;autoscalingTargets&quot;: { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
142 &quot;cpuUtilizationPercent&quot;: 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), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error.
143 &quot;storageUtilizationGibPerNode&quot;: 42, # The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD.
144 },
145 },
146 },
147 &quot;defaultStorageType&quot;: &quot;A String&quot;, # Immutable. The type of storage used by this cluster to serve its parent instance&#x27;s tables, unless explicitly overridden.
148 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
149 &quot;kmsKeyName&quot;: &quot;A String&quot;, # 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. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
150 },
151 &quot;location&quot;: &quot;A String&quot;, # Immutable. The location where this cluster&#x27;s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
152 &quot;name&quot;: &quot;A String&quot;, # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
153 &quot;nodeScalingFactor&quot;: &quot;A String&quot;, # Immutable. The node scaling factor of this cluster.
154 &quot;serveNodes&quot;: 42, # The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
155 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
156 }
157
158 clusterId: string, Required. The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`.
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164 Returns:
165 An object of the form:
166
167 { # This resource represents a long-running operation that is the result of a network API call.
168 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
169 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
170 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
171 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
172 {
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175 ],
176 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
177 },
178 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
181 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
182 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
183 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184 },
185 }</pre>
186 </div>
187
188 <div class="method">
189 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
190 <pre>Deletes a cluster from an instance.
191
192 Args:
193 name: string, Required. The unique name of the cluster to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199 Returns:
200 An object of the form:
201
202 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
203 }</pre>
204 </div>
205
206 <div class="method">
207 <code class="details" id="get">get(name, x__xgafv=None)</code>
208 <pre>Gets information about a cluster.
209
210 Args:
211 name: string, Required. The unique name of the requested cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
212 x__xgafv: string, V1 error format.
213 Allowed values
214 1 - v1 error format
215 2 - v2 error format
216
217 Returns:
218 An object of the form:
219
220 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
221 &quot;clusterConfig&quot;: { # Configuration for a cluster. # Configuration for this cluster.
222 &quot;clusterAutoscalingConfig&quot;: { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster.
223 &quot;autoscalingLimits&quot;: { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
224 &quot;maxServeNodes&quot;: 42, # Required. Maximum number of nodes to scale up to.
225 &quot;minServeNodes&quot;: 42, # Required. Minimum number of nodes to scale down to.
226 },
227 &quot;autoscalingTargets&quot;: { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
228 &quot;cpuUtilizationPercent&quot;: 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), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error.
229 &quot;storageUtilizationGibPerNode&quot;: 42, # The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD.
230 },
231 },
232 },
233 &quot;defaultStorageType&quot;: &quot;A String&quot;, # Immutable. The type of storage used by this cluster to serve its parent instance&#x27;s tables, unless explicitly overridden.
234 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
235 &quot;kmsKeyName&quot;: &quot;A String&quot;, # 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. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
236 },
237 &quot;location&quot;: &quot;A String&quot;, # Immutable. The location where this cluster&#x27;s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
238 &quot;name&quot;: &quot;A String&quot;, # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
239 &quot;nodeScalingFactor&quot;: &quot;A String&quot;, # Immutable. The node scaling factor of this cluster.
240 &quot;serveNodes&quot;: 42, # The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
241 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
242 }</pre>
243 </div>
244
245 <div class="method">
246 <code class="details" id="getMemoryLayer">getMemoryLayer(name, x__xgafv=None)</code>
247 <pre>Gets information about the memory layer of a cluster.
248
249 Args:
250 name: string, Required. The unique name of the requested cluster&#x27;s memory layer. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer`. (required)
251 x__xgafv: string, V1 error format.
252 Allowed values
253 1 - v1 error format
254 2 - v2 error format
255
256 Returns:
257 An object of the form:
258
259 { # The memory layer of a cluster. A memory layer serves reads from memory without hitting the backing persistent data store.
260 &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag for this memory layer. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
261 &quot;memoryConfig&quot;: { # Configuration of a memory layer. # The configuration of this memory layer. Set an empty `memory_config` to enable the memory layer. Unset this to disable the memory layer.
262 &quot;storageSizeGib&quot;: 42, # Output only. Reporting the current size of the memory layer in GiB.
263 },
264 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the memory layer. This is always: &quot;projects/{project}/instances/{instance}/clusters/{cluster}/memoryLayer&quot;.
265 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the memory layer.
266 }</pre>
267 </div>
268
269 <div class="method">
270 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
271 <pre>Lists information about clusters in an instance.
272
273 Args:
274 parent: string, 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} = &#x27;-&#x27;` to list Clusters for all Instances in a project, e.g., `projects/myproject/instances/-`. (required)
275 pageToken: string, DEPRECATED: This field is unused and ignored.
276 x__xgafv: string, V1 error format.
277 Allowed values
278 1 - v1 error format
279 2 - v2 error format
280
281 Returns:
282 An object of the form:
283
284 { # Response message for BigtableInstanceAdmin.ListClusters.
285 &quot;clusters&quot;: [ # The list of requested clusters.
286 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
287 &quot;clusterConfig&quot;: { # Configuration for a cluster. # Configuration for this cluster.
288 &quot;clusterAutoscalingConfig&quot;: { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster.
289 &quot;autoscalingLimits&quot;: { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
290 &quot;maxServeNodes&quot;: 42, # Required. Maximum number of nodes to scale up to.
291 &quot;minServeNodes&quot;: 42, # Required. Minimum number of nodes to scale down to.
292 },
293 &quot;autoscalingTargets&quot;: { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
294 &quot;cpuUtilizationPercent&quot;: 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), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error.
295 &quot;storageUtilizationGibPerNode&quot;: 42, # The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD.
296 },
297 },
298 },
299 &quot;defaultStorageType&quot;: &quot;A String&quot;, # Immutable. The type of storage used by this cluster to serve its parent instance&#x27;s tables, unless explicitly overridden.
300 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
301 &quot;kmsKeyName&quot;: &quot;A String&quot;, # 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. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
302 },
303 &quot;location&quot;: &quot;A String&quot;, # Immutable. The location where this cluster&#x27;s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
304 &quot;name&quot;: &quot;A String&quot;, # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
305 &quot;nodeScalingFactor&quot;: &quot;A String&quot;, # Immutable. The node scaling factor of this cluster.
306 &quot;serveNodes&quot;: 42, # The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
307 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
308 },
309 ],
310 &quot;failedLocations&quot;: [ # Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from `clusters`, or may only have partial information returned. Values are of the form `projects//locations/`
311 &quot;A String&quot;,
312 ],
313 &quot;nextPageToken&quot;: &quot;A String&quot;, # DEPRECATED: This field is unused and ignored.
314 }</pre>
315 </div>
316
317 <div class="method">
318 <code class="details" id="list_next">list_next()</code>
319 <pre>Retrieves the next page of results.
320
321 Args:
322 previous_request: The request for the previous page. (required)
323 previous_response: The response from the request for the previous page. (required)
324
325 Returns:
326 A request object that you can call &#x27;execute()&#x27; on to request the next
327 page. Returns None if there are no more items in the collection.
328 </pre>
329 </div>
330
331 <div class="method">
332 <code class="details" id="partialUpdateCluster">partialUpdateCluster(name, body=None, updateMask=None, x__xgafv=None)</code>
333 <pre>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.
334
335 Args:
336 name: string, The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. (required)
337 body: object, The request body.
338 The object takes the form of:
339
340 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
341 &quot;clusterConfig&quot;: { # Configuration for a cluster. # Configuration for this cluster.
342 &quot;clusterAutoscalingConfig&quot;: { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster.
343 &quot;autoscalingLimits&quot;: { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
344 &quot;maxServeNodes&quot;: 42, # Required. Maximum number of nodes to scale up to.
345 &quot;minServeNodes&quot;: 42, # Required. Minimum number of nodes to scale down to.
346 },
347 &quot;autoscalingTargets&quot;: { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
348 &quot;cpuUtilizationPercent&quot;: 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), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error.
349 &quot;storageUtilizationGibPerNode&quot;: 42, # The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD.
350 },
351 },
352 },
353 &quot;defaultStorageType&quot;: &quot;A String&quot;, # Immutable. The type of storage used by this cluster to serve its parent instance&#x27;s tables, unless explicitly overridden.
354 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
355 &quot;kmsKeyName&quot;: &quot;A String&quot;, # 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. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
356 },
357 &quot;location&quot;: &quot;A String&quot;, # Immutable. The location where this cluster&#x27;s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
358 &quot;name&quot;: &quot;A String&quot;, # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
359 &quot;nodeScalingFactor&quot;: &quot;A String&quot;, # Immutable. The node scaling factor of this cluster.
360 &quot;serveNodes&quot;: 42, # The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
361 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
362 }
363
364 updateMask: string, Required. The subset of Cluster fields which should be replaced.
365 x__xgafv: string, V1 error format.
366 Allowed values
367 1 - v1 error format
368 2 - v2 error format
369
370 Returns:
371 An object of the form:
372
373 { # This resource represents a long-running operation that is the result of a network API call.
374 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
375 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
376 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
377 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
378 {
379 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
380 },
381 ],
382 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
383 },
384 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
385 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
386 },
387 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
388 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
389 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
390 },
391 }</pre>
392 </div>
393
394 <div class="method">
395 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
396 <pre>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.
397
398 Args:
399 name: string, The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. (required)
400 body: object, The request body.
401 The object takes the form of:
402
403 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
404 &quot;clusterConfig&quot;: { # Configuration for a cluster. # Configuration for this cluster.
405 &quot;clusterAutoscalingConfig&quot;: { # Autoscaling config for a cluster. # Autoscaling configuration for this cluster.
406 &quot;autoscalingLimits&quot;: { # Limits for the number of nodes a Cluster can autoscale up/down to. # Required. Autoscaling limits for this cluster.
407 &quot;maxServeNodes&quot;: 42, # Required. Maximum number of nodes to scale up to.
408 &quot;minServeNodes&quot;: 42, # Required. Minimum number of nodes to scale down to.
409 },
410 &quot;autoscalingTargets&quot;: { # The Autoscaling targets for a Cluster. These determine the recommended nodes. # Required. Autoscaling targets for this cluster.
411 &quot;cpuUtilizationPercent&quot;: 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), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error.
412 &quot;storageUtilizationGibPerNode&quot;: 42, # The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD.
413 },
414 },
415 },
416 &quot;defaultStorageType&quot;: &quot;A String&quot;, # Immutable. The type of storage used by this cluster to serve its parent instance&#x27;s tables, unless explicitly overridden.
417 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
418 &quot;kmsKeyName&quot;: &quot;A String&quot;, # 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. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
419 },
420 &quot;location&quot;: &quot;A String&quot;, # Immutable. The location where this cluster&#x27;s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
421 &quot;name&quot;: &quot;A String&quot;, # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
422 &quot;nodeScalingFactor&quot;: &quot;A String&quot;, # Immutable. The node scaling factor of this cluster.
423 &quot;serveNodes&quot;: 42, # The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
424 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
425 }
426
427 x__xgafv: string, V1 error format.
428 Allowed values
429 1 - v1 error format
430 2 - v2 error format
431
432 Returns:
433 An object of the form:
434
435 { # This resource represents a long-running operation that is the result of a network API call.
436 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
437 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
438 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
439 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
440 {
441 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
442 },
443 ],
444 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
445 },
446 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
447 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
448 },
449 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
450 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
451 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
452 },
453 }</pre>
454 </div>
455
456 </body></html>