Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 31fbcc014f8642fb0cde7de47889b55a2eaf3f71 / . / docs / dyn / bigtableadmin_v2.projects.instances.clusters.html
blob: a5440eb8050bcee41eb3bfdf0441848dd3444ccc [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 <code><a href="#create">create(parent, body=None, clusterId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87<p class="firstline">Creates a cluster within an instance.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes a cluster from an instance.</p>
91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Gets information about a cluster.</p>
94<p class="toc_element">
95 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p>
96<p class="firstline">Lists information about clusters in an instance.</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]101 <code><a href="#partialUpdateCluster">partialUpdateCluster(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Partially updates a cluster within a project. This method is the preferred way to update a Cluster. </p>
103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]105<p class="firstline">Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<h3>Method Details</h3>
107<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108 <code class="details" id="close">close()</code>
109 <pre>Close httplib2 connections.</pre>
110</div>
111
112<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]113 <code class="details" id="create">create(parent, body=None, clusterId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 <pre>Creates a cluster within an instance.
115
116Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 The object takes the form of:
120
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]122 &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.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]123 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
124 &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. 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}`
125 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]126 &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}`.
127 &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*`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]128 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]129 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130}
131
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 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`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
137
138Returns:
139 An object of the form:
140
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]141 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]142 &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.
143 &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.
144 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
145 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
146 {
147 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
148 },
149 ],
150 &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.
151 },
152 &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.
153 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
154 },
155 &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}`.
156 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158 },
159}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160</div>
161
162<div class="method">
163 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
164 <pre>Deletes a cluster from an instance.
165
166Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]167 name: string, Required. The unique name of the cluster to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173Returns:
174 An object of the form:
175
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]177}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178</div>
179
180<div class="method">
181 <code class="details" id="get">get(name, x__xgafv=None)</code>
182 <pre>Gets information about a cluster.
183
184Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]185 name: string, Required. The unique name of the requested cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
190
191Returns:
192 An object of the form:
193
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]194 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]195 &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.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]196 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
197 &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. 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}`
198 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]199 &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}`.
200 &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*`.
201 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
202 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
203}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]204</div>
205
206<div class="method">
207 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
208 <pre>Lists information about clusters in an instance.
209
210Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]211 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)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 pageToken: string, DEPRECATED: This field is unused and ignored.
213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218Returns:
219 An object of the form:
220
221 { # Response message for BigtableInstanceAdmin.ListClusters.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]222 &quot;clusters&quot;: [ # The list of requested clusters.
223 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
224 &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.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]225 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
226 &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. 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}`
227 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]228 &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}`.
229 &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*`.
230 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
231 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
232 },
233 ],
234 &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/`
235 &quot;A String&quot;,
236 ],
237 &quot;nextPageToken&quot;: &quot;A String&quot;, # DEPRECATED: This field is unused and ignored.
238}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239</div>
240
241<div class="method">
242 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
243 <pre>Retrieves the next page of results.
244
245Args:
246 previous_request: The request for the previous page. (required)
247 previous_response: The response from the request for the previous page. (required)
248
249Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 page. Returns None if there are no more items in the collection.
252 </pre>
253</div>
254
255<div class="method">
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]256 <code class="details" id="partialUpdateCluster">partialUpdateCluster(name, body=None, updateMask=None, x__xgafv=None)</code>
257 <pre>Partially updates a cluster within a project. This method is the preferred way to update a Cluster.
258
259Args:
260 name: string, The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. (required)
261 body: object, The request body.
262 The object takes the form of:
263
264{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
265 &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.
266 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
267 &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. 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}`
268 },
269 &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}`.
270 &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*`.
271 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
272 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
273}
274
275 updateMask: string, Required. The subset of Cluster fields which should be replaced. Must be explicitly set.
276 x__xgafv: string, V1 error format.
277 Allowed values
278 1 - v1 error format
279 2 - v2 error format
280
281Returns:
282 An object of the form:
283
284 { # This resource represents a long-running operation that is the result of a network API call.
285 &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.
286 &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.
287 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
288 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
289 {
290 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
291 },
292 ],
293 &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.
294 },
295 &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.
296 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
297 },
298 &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}`.
299 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
300 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
301 },
302}</pre>
303</div>
304
305<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]306 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]307 <pre>Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308
309Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]310 name: string, The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]311 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]312 The object takes the form of:
313
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]314{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]315 &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.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]316 &quot;encryptionConfig&quot;: { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
317 &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. 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}`
318 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]319 &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}`.
320 &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*`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]321 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]322 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]323}
324
325 x__xgafv: string, V1 error format.
326 Allowed values
327 1 - v1 error format
328 2 - v2 error format
329
330Returns:
331 An object of the form:
332
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]333 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]334 &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.
335 &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.
336 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
337 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
338 {
339 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
340 },
341 ],
342 &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.
343 },
344 &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.
345 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
346 },
347 &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}`.
348 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
349 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
350 },
351}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]352</div>
353
354</body></html>