Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / bigtableadmin_v2.projects.instances.clusters.html
blob: 94b553dd12c8b5f50a59ef81cf39e52eb9ac2b9b [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">
83 <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]84<p class="firstline">Creates a cluster within an instance.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes a cluster from an instance.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets information about a cluster.</p>
91<p class="toc_element">
92 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p>
93<p class="firstline">Lists information about clusters in an instance.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99<p class="firstline">Updates a cluster within an instance.</p>
100<h3>Method Details</h3>
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <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]103 <pre>Creates a cluster within an instance.
104
105Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 parent: string, Required. The unique name of the instance in which to create the new cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108`projects/{project}/instances/{instance}`. (required)
109 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 The object takes the form of:
111
112{ # A resizable group of nodes in a particular cloud location, capable
113 # of serving all Tables in the parent
114 # Instance.
115 "defaultStorageType": "A String", # (`CreationOnly`)
116 # The type of storage used by this cluster to serve its
117 # parent instance's tables, unless explicitly overridden.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 # throughput and more consistent performance.
120 "state": "A String", # (`OutputOnly`)
121 # The current state of the cluster.
122 "location": "A String", # (`CreationOnly`)
123 # The location where this cluster's nodes and storage reside. For best
124 # performance, clients should be located as close as possible to this
125 # cluster. Currently only zones are supported, so values should be of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]126 # form `projects/{project}/locations/{zone}`.
127 "name": "A String", # Required. (`OutputOnly`)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 # The unique name of the cluster. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]129 # `projects/{project}/instances/{instance}/clusters/a-z*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130}
131
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]132 clusterId: string, Required. The ID to be used when referring to the new cluster within its instance,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133e.g., just `mycluster` rather than
134`projects/myproject/instances/myinstance/clusters/mycluster`.
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140Returns:
141 An object of the form:
142
143 { # This resource represents a long-running operation that is the result of a
144 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]145 "response": { # The normal response of the operation in case of success. If the original
146 # method returns no data on success, such as `Delete`, the response is
147 # `google.protobuf.Empty`. If the original method is standard
148 # `Get`/`Create`/`Update`, the response should be the resource. For other
149 # methods, the response should have the type `XxxResponse`, where `Xxx`
150 # is the original method name. For example, if the original method name
151 # is `TakeSnapshot()`, the inferred response type is
152 # `TakeSnapshotResponse`.
153 "a_key": "", # Properties of the object. Contains field @type with type URL.
154 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 "metadata": { # Service-specific metadata associated with the operation. It typically
156 # contains progress information and common metadata such as create time.
157 # Some services might not provide such metadata. Any method that returns a
158 # long-running operation should document the metadata type, if any.
159 "a_key": "", # Properties of the object. Contains field @type with type URL.
160 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]161 "done": True or False, # If the value is `false`, it means the operation is still in progress.
162 # If `true`, the operation is completed, and either `error` or `response` is
163 # available.
164 "name": "A String", # The server-assigned name, which is only unique within the same service that
165 # originally returns it. If you use the default HTTP mapping, the
166 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
168 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]169 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
170 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]172 # You can find out more about this error model and how to work with it in the
173 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]174 "message": "A String", # A developer-facing error message, which should be in English. Any
175 # user-facing error message should be localized and sent in the
176 # google.rpc.Status.details field, or localized by the client.
177 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
178 "details": [ # A list of messages that carry the error details. There is a common set of
179 # message types for APIs to use.
180 {
181 "a_key": "", # Properties of the object. Contains field @type with type URL.
182 },
183 ],
184 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
192Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]193 name: string, Required. The unique name of the cluster to be deleted. Values are of the form
194`projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200Returns:
201 An object of the form:
202
203 { # A generic empty message that you can re-use to avoid defining duplicated
204 # empty messages in your APIs. A typical example is to use it as the request
205 # or the response type of an API method. For instance:
206 #
207 # service Foo {
208 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
209 # }
210 #
211 # The JSON representation for `Empty` is empty JSON object `{}`.
212 }</pre>
213</div>
214
215<div class="method">
216 <code class="details" id="get">get(name, x__xgafv=None)</code>
217 <pre>Gets information about a cluster.
218
219Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]220 name: string, Required. The unique name of the requested cluster. Values are of the form
221`projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
226
227Returns:
228 An object of the form:
229
230 { # A resizable group of nodes in a particular cloud location, capable
231 # of serving all Tables in the parent
232 # Instance.
233 "defaultStorageType": "A String", # (`CreationOnly`)
234 # The type of storage used by this cluster to serve its
235 # parent instance's tables, unless explicitly overridden.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]236 "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 # throughput and more consistent performance.
238 "state": "A String", # (`OutputOnly`)
239 # The current state of the cluster.
240 "location": "A String", # (`CreationOnly`)
241 # The location where this cluster's nodes and storage reside. For best
242 # performance, clients should be located as close as possible to this
243 # cluster. Currently only zones are supported, so values should be of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]244 # form `projects/{project}/locations/{zone}`.
245 "name": "A String", # Required. (`OutputOnly`)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 # The unique name of the cluster. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]247 # `projects/{project}/instances/{instance}/clusters/a-z*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 }</pre>
249</div>
250
251<div class="method">
252 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
253 <pre>Lists information about clusters in an instance.
254
255Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]256 parent: string, Required. The unique name of the instance for which a list of clusters is requested.
257Values are of the form `projects/{project}/instances/{instance}`.
258Use `{instance} = '-'` to list Clusters for all Instances in a project,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]259e.g., `projects/myproject/instances/-`. (required)
260 pageToken: string, DEPRECATED: This field is unused and ignored.
261 x__xgafv: string, V1 error format.
262 Allowed values
263 1 - v1 error format
264 2 - v2 error format
265
266Returns:
267 An object of the form:
268
269 { # Response message for BigtableInstanceAdmin.ListClusters.
270 "nextPageToken": "A String", # DEPRECATED: This field is unused and ignored.
271 "clusters": [ # The list of requested clusters.
272 { # A resizable group of nodes in a particular cloud location, capable
273 # of serving all Tables in the parent
274 # Instance.
275 "defaultStorageType": "A String", # (`CreationOnly`)
276 # The type of storage used by this cluster to serve its
277 # parent instance's tables, unless explicitly overridden.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]278 "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 # throughput and more consistent performance.
280 "state": "A String", # (`OutputOnly`)
281 # The current state of the cluster.
282 "location": "A String", # (`CreationOnly`)
283 # The location where this cluster's nodes and storage reside. For best
284 # performance, clients should be located as close as possible to this
285 # cluster. Currently only zones are supported, so values should be of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]286 # form `projects/{project}/locations/{zone}`.
287 "name": "A String", # Required. (`OutputOnly`)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 # The unique name of the cluster. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 # `projects/{project}/instances/{instance}/clusters/a-z*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 },
291 ],
292 "failedLocations": [ # Locations from which Cluster information could not be retrieved,
293 # due to an outage or some other transient condition.
294 # Clusters from these locations may be missing from `clusters`,
295 # or may only have partial information returned.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]296 # Values are of the form `projects/&lt;project&gt;/locations/&lt;zone_id&gt;`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 "A String",
298 ],
299 }</pre>
300</div>
301
302<div class="method">
303 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
304 <pre>Retrieves the next page of results.
305
306Args:
307 previous_request: The request for the previous page. (required)
308 previous_response: The response from the request for the previous page. (required)
309
310Returns:
311 A request object that you can call 'execute()' on to request the next
312 page. Returns None if there are no more items in the collection.
313 </pre>
314</div>
315
316<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]317 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318 <pre>Updates a cluster within an instance.
319
320Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]321 name: string, Required. (`OutputOnly`)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]322The unique name of the cluster. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]323`projects/{project}/instances/{instance}/clusters/a-z*`. (required)
324 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325 The object takes the form of:
326
327{ # A resizable group of nodes in a particular cloud location, capable
328 # of serving all Tables in the parent
329 # Instance.
330 "defaultStorageType": "A String", # (`CreationOnly`)
331 # The type of storage used by this cluster to serve its
332 # parent instance's tables, unless explicitly overridden.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]333 "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 # throughput and more consistent performance.
335 "state": "A String", # (`OutputOnly`)
336 # The current state of the cluster.
337 "location": "A String", # (`CreationOnly`)
338 # The location where this cluster's nodes and storage reside. For best
339 # performance, clients should be located as close as possible to this
340 # cluster. Currently only zones are supported, so values should be of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]341 # form `projects/{project}/locations/{zone}`.
342 "name": "A String", # Required. (`OutputOnly`)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343 # The unique name of the cluster. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]344 # `projects/{project}/instances/{instance}/clusters/a-z*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345}
346
347 x__xgafv: string, V1 error format.
348 Allowed values
349 1 - v1 error format
350 2 - v2 error format
351
352Returns:
353 An object of the form:
354
355 { # This resource represents a long-running operation that is the result of a
356 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]357 "response": { # The normal response of the operation in case of success. If the original
358 # method returns no data on success, such as `Delete`, the response is
359 # `google.protobuf.Empty`. If the original method is standard
360 # `Get`/`Create`/`Update`, the response should be the resource. For other
361 # methods, the response should have the type `XxxResponse`, where `Xxx`
362 # is the original method name. For example, if the original method name
363 # is `TakeSnapshot()`, the inferred response type is
364 # `TakeSnapshotResponse`.
365 "a_key": "", # Properties of the object. Contains field @type with type URL.
366 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]367 "metadata": { # Service-specific metadata associated with the operation. It typically
368 # contains progress information and common metadata such as create time.
369 # Some services might not provide such metadata. Any method that returns a
370 # long-running operation should document the metadata type, if any.
371 "a_key": "", # Properties of the object. Contains field @type with type URL.
372 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]373 "done": True or False, # If the value is `false`, it means the operation is still in progress.
374 # If `true`, the operation is completed, and either `error` or `response` is
375 # available.
376 "name": "A String", # The server-assigned name, which is only unique within the same service that
377 # originally returns it. If you use the default HTTP mapping, the
378 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]379 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
380 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]381 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
382 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]383 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]384 # You can find out more about this error model and how to work with it in the
385 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 "message": "A String", # A developer-facing error message, which should be in English. Any
387 # user-facing error message should be localized and sent in the
388 # google.rpc.Status.details field, or localized by the client.
389 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
390 "details": [ # A list of messages that carry the error details. There is a common set of
391 # message types for APIs to use.
392 {
393 "a_key": "", # Properties of the object. Contains field @type with type URL.
394 },
395 ],
396 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]397 }</pre>
398</div>
399
400</body></html>