Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / bigtableadmin_v2.projects.instances.clusters.html
blob: 0bde7d2f8ecb3818089b4d7f22d9832a084bbde9 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 <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]102<p class="firstline">Updates a cluster within an instance.</p>
103<h3>Method Details</h3>
104<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]105 <code class="details" id="close">close()</code>
106 <pre>Close httplib2 connections.</pre>
107</div>
108
109<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110 <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]111 <pre>Creates a cluster within an instance.
112
113Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 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]115 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 The object takes the form of:
117
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]119 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]120 &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}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]121 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
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.
123 &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*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124}
125
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 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]127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]135 { # This resource represents a long-running operation that is the result of a network API call.
136 &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}`.
137 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]138 &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`.
139 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
140 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]141 &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.
142 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
143 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]144 &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.
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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 {
147 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
148 },
149 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]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 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]152 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
158 <pre>Deletes a cluster from an instance.
159
160Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]161 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]162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166
167Returns:
168 An object of the form:
169
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]170 { # 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 `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="get">get(name, x__xgafv=None)</code>
176 <pre>Gets information about a cluster.
177
178Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]179 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]180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185Returns:
186 An object of the form:
187
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]188 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]189 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]190 &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}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]191 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
192 &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.
193 &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*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 }</pre>
195</div>
196
197<div class="method">
198 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
199 <pre>Lists information about clusters in an instance.
200
201Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 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]203 pageToken: string, DEPRECATED: This field is unused and ignored.
204 x__xgafv: string, V1 error format.
205 Allowed values
206 1 - v1 error format
207 2 - v2 error format
208
209Returns:
210 An object of the form:
211
212 { # Response message for BigtableInstanceAdmin.ListClusters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]213 &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/`
214 &quot;A String&quot;,
215 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]216 &quot;clusters&quot;: [ # The list of requested clusters.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]217 { # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]218 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]219 &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}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]220 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
221 &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.
222 &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*`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]223 },
224 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]225 &quot;nextPageToken&quot;: &quot;A String&quot;, # DEPRECATED: This field is unused and ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
231 <pre>Retrieves the next page of results.
232
233Args:
234 previous_request: The request for the previous page. (required)
235 previous_response: The response from the request for the previous page. (required)
236
237Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238 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]239 page. Returns None if there are no more items in the collection.
240 </pre>
241</div>
242
243<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]244 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245 <pre>Updates a cluster within an instance.
246
247Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]248 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]249 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 The object takes the form of:
251
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]252{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]253 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the cluster.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]254 &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}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]255 &quot;serveNodes&quot;: 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
256 &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.
257 &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*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258}
259
260 x__xgafv: string, V1 error format.
261 Allowed values
262 1 - v1 error format
263 2 - v2 error format
264
265Returns:
266 An object of the form:
267
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]268 { # This resource represents a long-running operation that is the result of a network API call.
269 &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}`.
270 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]271 &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`.
272 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
273 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]274 &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.
275 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
276 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]277 &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.
278 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]279 {
280 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
281 },
282 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]283 &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.
284 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]285 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]286 }</pre>
287</div>
288
289</body></html>