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"> 78 <code><a href="#create">create(parent, body, clusterId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a cluster within an instance.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a cluster from an instance.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets information about a cluster.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists information about clusters in an instance.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates a cluster within an instance.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="create">create(parent, body, clusterId=None, x__xgafv=None)</code> 98 <pre>Creates a cluster within an instance. 99 100Args: 101 parent: string, The unique name of the instance in which to create the new cluster. 102Values are of the form 103`projects/<project>/instances/<instance>`. (required) 104 body: object, The request body. (required) 105 The object takes the form of: 106 107{ # A resizable group of nodes in a particular cloud location, capable 108 # of serving all Tables in the parent 109 # Instance. 110 "defaultStorageType": "A String", # (`CreationOnly`) 111 # The type of storage used by this cluster to serve its 112 # parent instance's tables, unless explicitly overridden. 113 "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher 114 # throughput and more consistent performance. 115 "state": "A String", # (`OutputOnly`) 116 # The current state of the cluster. 117 "location": "A String", # (`CreationOnly`) 118 # The location where this cluster's nodes and storage reside. For best 119 # performance, clients should be located as close as possible to this 120 # cluster. Currently only zones are supported, so values should be of the 121 # form `projects/<project>/locations/<zone>`. 122 "name": "A String", # (`OutputOnly`) 123 # The unique name of the cluster. Values are of the form 124 # `projects/<project>/instances/<instance>/clusters/a-z*`. 125} 126 127 clusterId: string, The ID to be used when referring to the new cluster within its instance, 128e.g., just `mycluster` rather than 129`projects/myproject/instances/myinstance/clusters/mycluster`. 130 x__xgafv: string, V1 error format. 131 Allowed values 132 1 - v1 error format 133 2 - v2 error format 134 135Returns: 136 An object of the form: 137 138 { # This resource represents a long-running operation that is the result of a 139 # network API call. 140 "metadata": { # Service-specific metadata associated with the operation. It typically 141 # contains progress information and common metadata such as create time. 142 # Some services might not provide such metadata. Any method that returns a 143 # long-running operation should document the metadata type, if any. 144 "a_key": "", # Properties of the object. Contains field @type with type URL. 145 }, 146 "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. 147 # different programming environments, including REST APIs and RPC APIs. It is 148 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 149 # 150 # - Simple to use and understand for most users 151 # - Flexible enough to meet unexpected needs 152 # 153 # # Overview 154 # 155 # The `Status` message contains three pieces of data: error code, error 156 # message, and error details. The error code should be an enum value of 157 # google.rpc.Code, but it may accept additional error codes if needed. The 158 # error message should be a developer-facing English message that helps 159 # developers *understand* and *resolve* the error. If a localized user-facing 160 # error message is needed, put the localized message in the error details or 161 # localize it in the client. The optional error details may contain arbitrary 162 # information about the error. There is a predefined set of error detail types 163 # in the package `google.rpc` that can be used for common error conditions. 164 # 165 # # Language mapping 166 # 167 # The `Status` message is the logical representation of the error model, but it 168 # is not necessarily the actual wire format. When the `Status` message is 169 # exposed in different client libraries and different wire protocols, it can be 170 # mapped differently. For example, it will likely be mapped to some exceptions 171 # in Java, but more likely mapped to some error codes in C. 172 # 173 # # Other uses 174 # 175 # The error model and the `Status` message can be used in a variety of 176 # environments, either with or without APIs, to provide a 177 # consistent developer experience across different environments. 178 # 179 # Example uses of this error model include: 180 # 181 # - Partial errors. If a service needs to return partial errors to the client, 182 # it may embed the `Status` in the normal response to indicate the partial 183 # errors. 184 # 185 # - Workflow errors. A typical workflow has multiple steps. Each step may 186 # have a `Status` message for error reporting. 187 # 188 # - Batch operations. If a client uses batch request and batch response, the 189 # `Status` message should be used directly inside batch response, one for 190 # each error sub-response. 191 # 192 # - Asynchronous operations. If an API call embeds asynchronous operation 193 # results in its response, the status of those operations should be 194 # represented directly using the `Status` message. 195 # 196 # - Logging. If some API errors are stored in logs, the message `Status` could 197 # be used directly after any stripping needed for security/privacy reasons. 198 "message": "A String", # A developer-facing error message, which should be in English. Any 199 # user-facing error message should be localized and sent in the 200 # google.rpc.Status.details field, or localized by the client. 201 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 202 "details": [ # A list of messages that carry the error details. There is a common set of 203 # message types for APIs to use. 204 { 205 "a_key": "", # Properties of the object. Contains field @type with type URL. 206 }, 207 ], 208 }, 209 "done": True or False, # If the value is `false`, it means the operation is still in progress. 210 # If `true`, the operation is completed, and either `error` or `response` is 211 # available. 212 "response": { # The normal response of the operation in case of success. If the original 213 # method returns no data on success, such as `Delete`, the response is 214 # `google.protobuf.Empty`. If the original method is standard 215 # `Get`/`Create`/`Update`, the response should be the resource. For other 216 # methods, the response should have the type `XxxResponse`, where `Xxx` 217 # is the original method name. For example, if the original method name 218 # is `TakeSnapshot()`, the inferred response type is 219 # `TakeSnapshotResponse`. 220 "a_key": "", # Properties of the object. Contains field @type with type URL. 221 }, 222 "name": "A String", # The server-assigned name, which is only unique within the same service that 223 # originally returns it. If you use the default HTTP mapping, the 224 # `name` should have the format of `operations/some/unique/name`. 225 }</pre> 226</div> 227 228<div class="method"> 229 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 230 <pre>Deletes a cluster from an instance. 231 232Args: 233 name: string, The unique name of the cluster to be deleted. Values are of the form 234`projects/<project>/instances/<instance>/clusters/<cluster>`. (required) 235 x__xgafv: string, V1 error format. 236 Allowed values 237 1 - v1 error format 238 2 - v2 error format 239 240Returns: 241 An object of the form: 242 243 { # A generic empty message that you can re-use to avoid defining duplicated 244 # empty messages in your APIs. A typical example is to use it as the request 245 # or the response type of an API method. For instance: 246 # 247 # service Foo { 248 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 249 # } 250 # 251 # The JSON representation for `Empty` is empty JSON object `{}`. 252 }</pre> 253</div> 254 255<div class="method"> 256 <code class="details" id="get">get(name, x__xgafv=None)</code> 257 <pre>Gets information about a cluster. 258 259Args: 260 name: string, The unique name of the requested cluster. Values are of the form 261`projects/<project>/instances/<instance>/clusters/<cluster>`. (required) 262 x__xgafv: string, V1 error format. 263 Allowed values 264 1 - v1 error format 265 2 - v2 error format 266 267Returns: 268 An object of the form: 269 270 { # A resizable group of nodes in a particular cloud location, capable 271 # of serving all Tables in the parent 272 # Instance. 273 "defaultStorageType": "A String", # (`CreationOnly`) 274 # The type of storage used by this cluster to serve its 275 # parent instance's tables, unless explicitly overridden. 276 "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher 277 # throughput and more consistent performance. 278 "state": "A String", # (`OutputOnly`) 279 # The current state of the cluster. 280 "location": "A String", # (`CreationOnly`) 281 # The location where this cluster's nodes and storage reside. For best 282 # performance, clients should be located as close as possible to this 283 # cluster. Currently only zones are supported, so values should be of the 284 # form `projects/<project>/locations/<zone>`. 285 "name": "A String", # (`OutputOnly`) 286 # The unique name of the cluster. Values are of the form 287 # `projects/<project>/instances/<instance>/clusters/a-z*`. 288 }</pre> 289</div> 290 291<div class="method"> 292 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code> 293 <pre>Lists information about clusters in an instance. 294 295Args: 296 parent: string, The unique name of the instance for which a list of clusters is requested. 297Values are of the form `projects/<project>/instances/<instance>`. 298Use `<instance> = '-'` to list Clusters for all Instances in a project, 299e.g., `projects/myproject/instances/-`. (required) 300 pageToken: string, DEPRECATED: This field is unused and ignored. 301 x__xgafv: string, V1 error format. 302 Allowed values 303 1 - v1 error format 304 2 - v2 error format 305 306Returns: 307 An object of the form: 308 309 { # Response message for BigtableInstanceAdmin.ListClusters. 310 "nextPageToken": "A String", # DEPRECATED: This field is unused and ignored. 311 "clusters": [ # The list of requested clusters. 312 { # A resizable group of nodes in a particular cloud location, capable 313 # of serving all Tables in the parent 314 # Instance. 315 "defaultStorageType": "A String", # (`CreationOnly`) 316 # The type of storage used by this cluster to serve its 317 # parent instance's tables, unless explicitly overridden. 318 "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher 319 # throughput and more consistent performance. 320 "state": "A String", # (`OutputOnly`) 321 # The current state of the cluster. 322 "location": "A String", # (`CreationOnly`) 323 # The location where this cluster's nodes and storage reside. For best 324 # performance, clients should be located as close as possible to this 325 # cluster. Currently only zones are supported, so values should be of the 326 # form `projects/<project>/locations/<zone>`. 327 "name": "A String", # (`OutputOnly`) 328 # The unique name of the cluster. Values are of the form 329 # `projects/<project>/instances/<instance>/clusters/a-z*`. 330 }, 331 ], 332 "failedLocations": [ # Locations from which Cluster information could not be retrieved, 333 # due to an outage or some other transient condition. 334 # Clusters from these locations may be missing from `clusters`, 335 # or may only have partial information returned. 336 # Values are of the form `projects/<project>/locations/<zone_id>` 337 "A String", 338 ], 339 }</pre> 340</div> 341 342<div class="method"> 343 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 344 <pre>Retrieves the next page of results. 345 346Args: 347 previous_request: The request for the previous page. (required) 348 previous_response: The response from the request for the previous page. (required) 349 350Returns: 351 A request object that you can call 'execute()' on to request the next 352 page. Returns None if there are no more items in the collection. 353 </pre> 354</div> 355 356<div class="method"> 357 <code class="details" id="update">update(name, body, x__xgafv=None)</code> 358 <pre>Updates a cluster within an instance. 359 360Args: 361 name: string, (`OutputOnly`) 362The unique name of the cluster. Values are of the form 363`projects/<project>/instances/<instance>/clusters/a-z*`. (required) 364 body: object, The request body. (required) 365 The object takes the form of: 366 367{ # A resizable group of nodes in a particular cloud location, capable 368 # of serving all Tables in the parent 369 # Instance. 370 "defaultStorageType": "A String", # (`CreationOnly`) 371 # The type of storage used by this cluster to serve its 372 # parent instance's tables, unless explicitly overridden. 373 "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher 374 # throughput and more consistent performance. 375 "state": "A String", # (`OutputOnly`) 376 # The current state of the cluster. 377 "location": "A String", # (`CreationOnly`) 378 # The location where this cluster's nodes and storage reside. For best 379 # performance, clients should be located as close as possible to this 380 # cluster. Currently only zones are supported, so values should be of the 381 # form `projects/<project>/locations/<zone>`. 382 "name": "A String", # (`OutputOnly`) 383 # The unique name of the cluster. Values are of the form 384 # `projects/<project>/instances/<instance>/clusters/a-z*`. 385} 386 387 x__xgafv: string, V1 error format. 388 Allowed values 389 1 - v1 error format 390 2 - v2 error format 391 392Returns: 393 An object of the form: 394 395 { # This resource represents a long-running operation that is the result of a 396 # network API call. 397 "metadata": { # Service-specific metadata associated with the operation. It typically 398 # contains progress information and common metadata such as create time. 399 # Some services might not provide such metadata. Any method that returns a 400 # long-running operation should document the metadata type, if any. 401 "a_key": "", # Properties of the object. Contains field @type with type URL. 402 }, 403 "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. 404 # different programming environments, including REST APIs and RPC APIs. It is 405 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 406 # 407 # - Simple to use and understand for most users 408 # - Flexible enough to meet unexpected needs 409 # 410 # # Overview 411 # 412 # The `Status` message contains three pieces of data: error code, error 413 # message, and error details. The error code should be an enum value of 414 # google.rpc.Code, but it may accept additional error codes if needed. The 415 # error message should be a developer-facing English message that helps 416 # developers *understand* and *resolve* the error. If a localized user-facing 417 # error message is needed, put the localized message in the error details or 418 # localize it in the client. The optional error details may contain arbitrary 419 # information about the error. There is a predefined set of error detail types 420 # in the package `google.rpc` that can be used for common error conditions. 421 # 422 # # Language mapping 423 # 424 # The `Status` message is the logical representation of the error model, but it 425 # is not necessarily the actual wire format. When the `Status` message is 426 # exposed in different client libraries and different wire protocols, it can be 427 # mapped differently. For example, it will likely be mapped to some exceptions 428 # in Java, but more likely mapped to some error codes in C. 429 # 430 # # Other uses 431 # 432 # The error model and the `Status` message can be used in a variety of 433 # environments, either with or without APIs, to provide a 434 # consistent developer experience across different environments. 435 # 436 # Example uses of this error model include: 437 # 438 # - Partial errors. If a service needs to return partial errors to the client, 439 # it may embed the `Status` in the normal response to indicate the partial 440 # errors. 441 # 442 # - Workflow errors. A typical workflow has multiple steps. Each step may 443 # have a `Status` message for error reporting. 444 # 445 # - Batch operations. If a client uses batch request and batch response, the 446 # `Status` message should be used directly inside batch response, one for 447 # each error sub-response. 448 # 449 # - Asynchronous operations. If an API call embeds asynchronous operation 450 # results in its response, the status of those operations should be 451 # represented directly using the `Status` message. 452 # 453 # - Logging. If some API errors are stored in logs, the message `Status` could 454 # be used directly after any stripping needed for security/privacy reasons. 455 "message": "A String", # A developer-facing error message, which should be in English. Any 456 # user-facing error message should be localized and sent in the 457 # google.rpc.Status.details field, or localized by the client. 458 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 459 "details": [ # A list of messages that carry the error details. There is a common set of 460 # message types for APIs to use. 461 { 462 "a_key": "", # Properties of the object. Contains field @type with type URL. 463 }, 464 ], 465 }, 466 "done": True or False, # If the value is `false`, it means the operation is still in progress. 467 # If `true`, the operation is completed, and either `error` or `response` is 468 # available. 469 "response": { # The normal response of the operation in case of success. If the original 470 # method returns no data on success, such as `Delete`, the response is 471 # `google.protobuf.Empty`. If the original method is standard 472 # `Get`/`Create`/`Update`, the response should be the resource. For other 473 # methods, the response should have the type `XxxResponse`, where `Xxx` 474 # is the original method name. For example, if the original method name 475 # is `TakeSnapshot()`, the inferred response type is 476 # `TakeSnapshotResponse`. 477 "a_key": "", # Properties of the object. Contains field @type with type URL. 478 }, 479 "name": "A String", # The server-assigned name, which is only unique within the same service that 480 # originally returns it. If you use the default HTTP mapping, the 481 # `name` should have the format of `operations/some/unique/name`. 482 }</pre> 483</div> 484 485</body></html>