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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="bigtableadmin_v2.projects.instances.appProfiles.html">appProfiles()</a></code> 79</p> 80<p class="firstline">Returns the appProfiles Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="bigtableadmin_v2.projects.instances.clusters.html">clusters()</a></code> 84</p> 85<p class="firstline">Returns the clusters Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="bigtableadmin_v2.projects.instances.tables.html">tables()</a></code> 89</p> 90<p class="firstline">Returns the tables Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> 94<p class="firstline">Create an instance within a project.</p> 95<p class="toc_element"> 96 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 97<p class="firstline">Delete an instance from a project.</p> 98<p class="toc_element"> 99 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 100<p class="firstline">Gets information about an instance.</p> 101<p class="toc_element"> 102 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Gets the access control policy for an instance resource. Returns an empty</p> 104<p class="toc_element"> 105 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Lists information about instances in a project.</p> 107<p class="toc_element"> 108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 109<p class="firstline">Retrieves the next page of results.</p> 110<p class="toc_element"> 111 <code><a href="#partialUpdateInstance">partialUpdateInstance(name, body, updateMask=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Partially updates an instance within a project. This method can modify all</p> 113<p class="toc_element"> 114 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p> 115<p class="firstline">Sets the access control policy on an instance resource. Replaces any</p> 116<p class="toc_element"> 117 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p> 118<p class="firstline">Returns permissions that the caller has on the specified instance resource.</p> 119<p class="toc_element"> 120 <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p> 121<p class="firstline">Updates an instance within a project. This method updates only the display</p> 122<h3>Method Details</h3> 123<div class="method"> 124 <code class="details" id="create">create(parent, body, x__xgafv=None)</code> 125 <pre>Create an instance within a project. 126 127Args: 128 parent: string, The unique name of the project in which to create the new instance. 129Values are of the form `projects/<project>`. (required) 130 body: object, The request body. (required) 131 The object takes the form of: 132 133{ # Request message for BigtableInstanceAdmin.CreateInstance. 134 "instanceId": "A String", # The ID to be used when referring to the new instance within its project, 135 # e.g., just `myinstance` rather than 136 # `projects/myproject/instances/myinstance`. 137 "clusters": { # The clusters to be created within the instance, mapped by desired 138 # cluster ID, e.g., just `mycluster` rather than 139 # `projects/myproject/instances/myinstance/clusters/mycluster`. 140 # Fields marked `OutputOnly` must be left blank. 141 # Currently, at most two clusters can be specified. 142 "a_key": { # A resizable group of nodes in a particular cloud location, capable 143 # of serving all Tables in the parent 144 # Instance. 145 "defaultStorageType": "A String", # (`CreationOnly`) 146 # The type of storage used by this cluster to serve its 147 # parent instance's tables, unless explicitly overridden. 148 "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher 149 # throughput and more consistent performance. 150 "state": "A String", # (`OutputOnly`) 151 # The current state of the cluster. 152 "location": "A String", # (`CreationOnly`) 153 # The location where this cluster's nodes and storage reside. For best 154 # performance, clients should be located as close as possible to this 155 # cluster. Currently only zones are supported, so values should be of the 156 # form `projects/<project>/locations/<zone>`. 157 "name": "A String", # (`OutputOnly`) 158 # The unique name of the cluster. Values are of the form 159 # `projects/<project>/instances/<instance>/clusters/a-z*`. 160 }, 161 }, 162 "parent": "A String", # The unique name of the project in which to create the new instance. 163 # Values are of the form `projects/<project>`. 164 "instance": { # A collection of Bigtable Tables and # The instance to create. 165 # Fields marked `OutputOnly` must be left blank. 166 # the resources that serve them. 167 # All tables in an instance are served from all 168 # Clusters in the instance. 169 "type": "A String", # The type of the instance. Defaults to `PRODUCTION`. 170 "state": "A String", # (`OutputOnly`) 171 # The current state of the instance. 172 "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud 173 # resources into groups that reflect a customer's organizational needs and 174 # deployment strategies. They can be used to filter resources and aggregate 175 # metrics. 176 # 177 # * Label keys must be between 1 and 63 characters long and must conform to 178 # the regular expression: `\p{Ll}\p{Lo}{0,62}`. 179 # * Label values must be between 0 and 63 characters long and must conform to 180 # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. 181 # * No more than 64 labels can be associated with a given resource. 182 # * Keys and values must both be under 128 bytes. 183 "a_key": "A String", 184 }, 185 "displayName": "A String", # The descriptive name for this instance as it appears in UIs. 186 # Can be changed at any time, but should be kept globally unique 187 # to avoid confusion. 188 "name": "A String", # (`OutputOnly`) 189 # The unique name of the instance. Values are of the form 190 # `projects/<project>/instances/a-z+[a-z0-9]`. 191 }, 192 } 193 194 x__xgafv: string, V1 error format. 195 Allowed values 196 1 - v1 error format 197 2 - v2 error format 198 199Returns: 200 An object of the form: 201 202 { # This resource represents a long-running operation that is the result of a 203 # network API call. 204 "metadata": { # Service-specific metadata associated with the operation. It typically 205 # contains progress information and common metadata such as create time. 206 # Some services might not provide such metadata. Any method that returns a 207 # long-running operation should document the metadata type, if any. 208 "a_key": "", # Properties of the object. Contains field @type with type URL. 209 }, 210 "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. 211 # different programming environments, including REST APIs and RPC APIs. It is 212 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 213 # 214 # - Simple to use and understand for most users 215 # - Flexible enough to meet unexpected needs 216 # 217 # # Overview 218 # 219 # The `Status` message contains three pieces of data: error code, error 220 # message, and error details. The error code should be an enum value of 221 # google.rpc.Code, but it may accept additional error codes if needed. The 222 # error message should be a developer-facing English message that helps 223 # developers *understand* and *resolve* the error. If a localized user-facing 224 # error message is needed, put the localized message in the error details or 225 # localize it in the client. The optional error details may contain arbitrary 226 # information about the error. There is a predefined set of error detail types 227 # in the package `google.rpc` that can be used for common error conditions. 228 # 229 # # Language mapping 230 # 231 # The `Status` message is the logical representation of the error model, but it 232 # is not necessarily the actual wire format. When the `Status` message is 233 # exposed in different client libraries and different wire protocols, it can be 234 # mapped differently. For example, it will likely be mapped to some exceptions 235 # in Java, but more likely mapped to some error codes in C. 236 # 237 # # Other uses 238 # 239 # The error model and the `Status` message can be used in a variety of 240 # environments, either with or without APIs, to provide a 241 # consistent developer experience across different environments. 242 # 243 # Example uses of this error model include: 244 # 245 # - Partial errors. If a service needs to return partial errors to the client, 246 # it may embed the `Status` in the normal response to indicate the partial 247 # errors. 248 # 249 # - Workflow errors. A typical workflow has multiple steps. Each step may 250 # have a `Status` message for error reporting. 251 # 252 # - Batch operations. If a client uses batch request and batch response, the 253 # `Status` message should be used directly inside batch response, one for 254 # each error sub-response. 255 # 256 # - Asynchronous operations. If an API call embeds asynchronous operation 257 # results in its response, the status of those operations should be 258 # represented directly using the `Status` message. 259 # 260 # - Logging. If some API errors are stored in logs, the message `Status` could 261 # be used directly after any stripping needed for security/privacy reasons. 262 "message": "A String", # A developer-facing error message, which should be in English. Any 263 # user-facing error message should be localized and sent in the 264 # google.rpc.Status.details field, or localized by the client. 265 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 266 "details": [ # A list of messages that carry the error details. There is a common set of 267 # message types for APIs to use. 268 { 269 "a_key": "", # Properties of the object. Contains field @type with type URL. 270 }, 271 ], 272 }, 273 "done": True or False, # If the value is `false`, it means the operation is still in progress. 274 # If `true`, the operation is completed, and either `error` or `response` is 275 # available. 276 "response": { # The normal response of the operation in case of success. If the original 277 # method returns no data on success, such as `Delete`, the response is 278 # `google.protobuf.Empty`. If the original method is standard 279 # `Get`/`Create`/`Update`, the response should be the resource. For other 280 # methods, the response should have the type `XxxResponse`, where `Xxx` 281 # is the original method name. For example, if the original method name 282 # is `TakeSnapshot()`, the inferred response type is 283 # `TakeSnapshotResponse`. 284 "a_key": "", # Properties of the object. Contains field @type with type URL. 285 }, 286 "name": "A String", # The server-assigned name, which is only unique within the same service that 287 # originally returns it. If you use the default HTTP mapping, the 288 # `name` should have the format of `operations/some/unique/name`. 289 }</pre> 290</div> 291 292<div class="method"> 293 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 294 <pre>Delete an instance from a project. 295 296Args: 297 name: string, The unique name of the instance to be deleted. 298Values are of the form `projects/<project>/instances/<instance>`. (required) 299 x__xgafv: string, V1 error format. 300 Allowed values 301 1 - v1 error format 302 2 - v2 error format 303 304Returns: 305 An object of the form: 306 307 { # A generic empty message that you can re-use to avoid defining duplicated 308 # empty messages in your APIs. A typical example is to use it as the request 309 # or the response type of an API method. For instance: 310 # 311 # service Foo { 312 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 313 # } 314 # 315 # The JSON representation for `Empty` is empty JSON object `{}`. 316 }</pre> 317</div> 318 319<div class="method"> 320 <code class="details" id="get">get(name, x__xgafv=None)</code> 321 <pre>Gets information about an instance. 322 323Args: 324 name: string, The unique name of the requested instance. Values are of the form 325`projects/<project>/instances/<instance>`. (required) 326 x__xgafv: string, V1 error format. 327 Allowed values 328 1 - v1 error format 329 2 - v2 error format 330 331Returns: 332 An object of the form: 333 334 { # A collection of Bigtable Tables and 335 # the resources that serve them. 336 # All tables in an instance are served from all 337 # Clusters in the instance. 338 "type": "A String", # The type of the instance. Defaults to `PRODUCTION`. 339 "state": "A String", # (`OutputOnly`) 340 # The current state of the instance. 341 "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud 342 # resources into groups that reflect a customer's organizational needs and 343 # deployment strategies. They can be used to filter resources and aggregate 344 # metrics. 345 # 346 # * Label keys must be between 1 and 63 characters long and must conform to 347 # the regular expression: `\p{Ll}\p{Lo}{0,62}`. 348 # * Label values must be between 0 and 63 characters long and must conform to 349 # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. 350 # * No more than 64 labels can be associated with a given resource. 351 # * Keys and values must both be under 128 bytes. 352 "a_key": "A String", 353 }, 354 "displayName": "A String", # The descriptive name for this instance as it appears in UIs. 355 # Can be changed at any time, but should be kept globally unique 356 # to avoid confusion. 357 "name": "A String", # (`OutputOnly`) 358 # The unique name of the instance. Values are of the form 359 # `projects/<project>/instances/a-z+[a-z0-9]`. 360 }</pre> 361</div> 362 363<div class="method"> 364 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> 365 <pre>Gets the access control policy for an instance resource. Returns an empty 366policy if an instance exists but does not have a policy set. 367 368Args: 369 resource: string, REQUIRED: The resource for which the policy is being requested. 370See the operation documentation for the appropriate value for this field. (required) 371 body: object, The request body. 372 The object takes the form of: 373 374{ # Request message for `GetIamPolicy` method. 375 } 376 377 x__xgafv: string, V1 error format. 378 Allowed values 379 1 - v1 error format 380 2 - v2 error format 381 382Returns: 383 An object of the form: 384 385 { # Defines an Identity and Access Management (IAM) policy. It is used to 386 # specify access control policies for Cloud Platform resources. 387 # 388 # 389 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 390 # `members` to a `role`, where the members can be user accounts, Google groups, 391 # Google domains, and service accounts. A `role` is a named list of permissions 392 # defined by IAM. 393 # 394 # **JSON Example** 395 # 396 # { 397 # "bindings": [ 398 # { 399 # "role": "roles/owner", 400 # "members": [ 401 # "user:mike@example.com", 402 # "group:admins@example.com", 403 # "domain:google.com", 404 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 405 # ] 406 # }, 407 # { 408 # "role": "roles/viewer", 409 # "members": ["user:sean@example.com"] 410 # } 411 # ] 412 # } 413 # 414 # **YAML Example** 415 # 416 # bindings: 417 # - members: 418 # - user:mike@example.com 419 # - group:admins@example.com 420 # - domain:google.com 421 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 422 # role: roles/owner 423 # - members: 424 # - user:sean@example.com 425 # role: roles/viewer 426 # 427 # 428 # For a description of IAM and its features, see the 429 # [IAM developer's guide](https://cloud.google.com/iam/docs). 430 "bindings": [ # Associates a list of `members` to a `role`. 431 # `bindings` with no members will result in an error. 432 { # Associates `members` with a `role`. 433 "role": "A String", # Role that is assigned to `members`. 434 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 435 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 436 # NOTE: An unsatisfied condition will not allow user access via current 437 # binding. Different bindings, including their conditions, are examined 438 # independently. 439 # 440 # title: "User account presence" 441 # description: "Determines whether the request has a user account" 442 # expression: "size(request.user) > 0" 443 "description": "A String", # An optional description of the expression. This is a longer text which 444 # describes the expression, e.g. when hovered over it in a UI. 445 "expression": "A String", # Textual representation of an expression in 446 # Common Expression Language syntax. 447 # 448 # The application context of the containing message determines which 449 # well-known feature set of CEL is supported. 450 "location": "A String", # An optional string indicating the location of the expression for error 451 # reporting, e.g. a file name and a position in the file. 452 "title": "A String", # An optional title for the expression, i.e. a short string describing 453 # its purpose. This can be used e.g. in UIs which allow to enter the 454 # expression. 455 }, 456 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 457 # `members` can have the following values: 458 # 459 # * `allUsers`: A special identifier that represents anyone who is 460 # on the internet; with or without a Google account. 461 # 462 # * `allAuthenticatedUsers`: A special identifier that represents anyone 463 # who is authenticated with a Google account or a service account. 464 # 465 # * `user:{emailid}`: An email address that represents a specific Google 466 # account. For example, `alice@gmail.com` . 467 # 468 # 469 # * `serviceAccount:{emailid}`: An email address that represents a service 470 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 471 # 472 # * `group:{emailid}`: An email address that represents a Google group. 473 # For example, `admins@example.com`. 474 # 475 # 476 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 477 # users of that domain. For example, `google.com` or `example.com`. 478 # 479 "A String", 480 ], 481 }, 482 ], 483 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 484 { # Specifies the audit configuration for a service. 485 # The configuration determines which permission types are logged, and what 486 # identities, if any, are exempted from logging. 487 # An AuditConfig must have one or more AuditLogConfigs. 488 # 489 # If there are AuditConfigs for both `allServices` and a specific service, 490 # the union of the two AuditConfigs is used for that service: the log_types 491 # specified in each AuditConfig are enabled, and the exempted_members in each 492 # AuditLogConfig are exempted. 493 # 494 # Example Policy with multiple AuditConfigs: 495 # 496 # { 497 # "audit_configs": [ 498 # { 499 # "service": "allServices" 500 # "audit_log_configs": [ 501 # { 502 # "log_type": "DATA_READ", 503 # "exempted_members": [ 504 # "user:foo@gmail.com" 505 # ] 506 # }, 507 # { 508 # "log_type": "DATA_WRITE", 509 # }, 510 # { 511 # "log_type": "ADMIN_READ", 512 # } 513 # ] 514 # }, 515 # { 516 # "service": "fooservice.googleapis.com" 517 # "audit_log_configs": [ 518 # { 519 # "log_type": "DATA_READ", 520 # }, 521 # { 522 # "log_type": "DATA_WRITE", 523 # "exempted_members": [ 524 # "user:bar@gmail.com" 525 # ] 526 # } 527 # ] 528 # } 529 # ] 530 # } 531 # 532 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 533 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 534 # bar@gmail.com from DATA_WRITE logging. 535 "auditLogConfigs": [ # The configuration for logging of each type of permission. 536 { # Provides the configuration for logging a type of permissions. 537 # Example: 538 # 539 # { 540 # "audit_log_configs": [ 541 # { 542 # "log_type": "DATA_READ", 543 # "exempted_members": [ 544 # "user:foo@gmail.com" 545 # ] 546 # }, 547 # { 548 # "log_type": "DATA_WRITE", 549 # } 550 # ] 551 # } 552 # 553 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 554 # foo@gmail.com from DATA_READ logging. 555 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 556 # permission. 557 # Follows the same format of Binding.members. 558 "A String", 559 ], 560 "logType": "A String", # The log type that this config enables. 561 }, 562 ], 563 "service": "A String", # Specifies a service that will be enabled for audit logging. 564 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 565 # `allServices` is a special value that covers all services. 566 }, 567 ], 568 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 569 # prevent simultaneous updates of a policy from overwriting each other. 570 # It is strongly suggested that systems make use of the `etag` in the 571 # read-modify-write cycle to perform policy updates in order to avoid race 572 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 573 # systems are expected to put that etag in the request to `setIamPolicy` to 574 # ensure that their change will be applied to the same version of the policy. 575 # 576 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 577 # policy is overwritten blindly. 578 "version": 42, # Deprecated. 579 }</pre> 580</div> 581 582<div class="method"> 583 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code> 584 <pre>Lists information about instances in a project. 585 586Args: 587 parent: string, The unique name of the project for which a list of instances is requested. 588Values are of the form `projects/<project>`. (required) 589 pageToken: string, DEPRECATED: This field is unused and ignored. 590 x__xgafv: string, V1 error format. 591 Allowed values 592 1 - v1 error format 593 2 - v2 error format 594 595Returns: 596 An object of the form: 597 598 { # Response message for BigtableInstanceAdmin.ListInstances. 599 "nextPageToken": "A String", # DEPRECATED: This field is unused and ignored. 600 "instances": [ # The list of requested instances. 601 { # A collection of Bigtable Tables and 602 # the resources that serve them. 603 # All tables in an instance are served from all 604 # Clusters in the instance. 605 "type": "A String", # The type of the instance. Defaults to `PRODUCTION`. 606 "state": "A String", # (`OutputOnly`) 607 # The current state of the instance. 608 "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud 609 # resources into groups that reflect a customer's organizational needs and 610 # deployment strategies. They can be used to filter resources and aggregate 611 # metrics. 612 # 613 # * Label keys must be between 1 and 63 characters long and must conform to 614 # the regular expression: `\p{Ll}\p{Lo}{0,62}`. 615 # * Label values must be between 0 and 63 characters long and must conform to 616 # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. 617 # * No more than 64 labels can be associated with a given resource. 618 # * Keys and values must both be under 128 bytes. 619 "a_key": "A String", 620 }, 621 "displayName": "A String", # The descriptive name for this instance as it appears in UIs. 622 # Can be changed at any time, but should be kept globally unique 623 # to avoid confusion. 624 "name": "A String", # (`OutputOnly`) 625 # The unique name of the instance. Values are of the form 626 # `projects/<project>/instances/a-z+[a-z0-9]`. 627 }, 628 ], 629 "failedLocations": [ # Locations from which Instance information could not be retrieved, 630 # due to an outage or some other transient condition. 631 # Instances whose Clusters are all in one of the failed locations 632 # may be missing from `instances`, and Instances with at least one 633 # Cluster in a failed location may only have partial information returned. 634 # Values are of the form `projects/<project>/locations/<zone_id>` 635 "A String", 636 ], 637 }</pre> 638</div> 639 640<div class="method"> 641 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 642 <pre>Retrieves the next page of results. 643 644Args: 645 previous_request: The request for the previous page. (required) 646 previous_response: The response from the request for the previous page. (required) 647 648Returns: 649 A request object that you can call 'execute()' on to request the next 650 page. Returns None if there are no more items in the collection. 651 </pre> 652</div> 653 654<div class="method"> 655 <code class="details" id="partialUpdateInstance">partialUpdateInstance(name, body, updateMask=None, x__xgafv=None)</code> 656 <pre>Partially updates an instance within a project. This method can modify all 657fields of an Instance and is the preferred way to update an Instance. 658 659Args: 660 name: string, (`OutputOnly`) 661The unique name of the instance. Values are of the form 662`projects/<project>/instances/a-z+[a-z0-9]`. (required) 663 body: object, The request body. (required) 664 The object takes the form of: 665 666{ # A collection of Bigtable Tables and 667 # the resources that serve them. 668 # All tables in an instance are served from all 669 # Clusters in the instance. 670 "type": "A String", # The type of the instance. Defaults to `PRODUCTION`. 671 "state": "A String", # (`OutputOnly`) 672 # The current state of the instance. 673 "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud 674 # resources into groups that reflect a customer's organizational needs and 675 # deployment strategies. They can be used to filter resources and aggregate 676 # metrics. 677 # 678 # * Label keys must be between 1 and 63 characters long and must conform to 679 # the regular expression: `\p{Ll}\p{Lo}{0,62}`. 680 # * Label values must be between 0 and 63 characters long and must conform to 681 # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. 682 # * No more than 64 labels can be associated with a given resource. 683 # * Keys and values must both be under 128 bytes. 684 "a_key": "A String", 685 }, 686 "displayName": "A String", # The descriptive name for this instance as it appears in UIs. 687 # Can be changed at any time, but should be kept globally unique 688 # to avoid confusion. 689 "name": "A String", # (`OutputOnly`) 690 # The unique name of the instance. Values are of the form 691 # `projects/<project>/instances/a-z+[a-z0-9]`. 692} 693 694 updateMask: string, The subset of Instance fields which should be replaced. 695Must be explicitly set. 696 x__xgafv: string, V1 error format. 697 Allowed values 698 1 - v1 error format 699 2 - v2 error format 700 701Returns: 702 An object of the form: 703 704 { # This resource represents a long-running operation that is the result of a 705 # network API call. 706 "metadata": { # Service-specific metadata associated with the operation. It typically 707 # contains progress information and common metadata such as create time. 708 # Some services might not provide such metadata. Any method that returns a 709 # long-running operation should document the metadata type, if any. 710 "a_key": "", # Properties of the object. Contains field @type with type URL. 711 }, 712 "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. 713 # different programming environments, including REST APIs and RPC APIs. It is 714 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 715 # 716 # - Simple to use and understand for most users 717 # - Flexible enough to meet unexpected needs 718 # 719 # # Overview 720 # 721 # The `Status` message contains three pieces of data: error code, error 722 # message, and error details. The error code should be an enum value of 723 # google.rpc.Code, but it may accept additional error codes if needed. The 724 # error message should be a developer-facing English message that helps 725 # developers *understand* and *resolve* the error. If a localized user-facing 726 # error message is needed, put the localized message in the error details or 727 # localize it in the client. The optional error details may contain arbitrary 728 # information about the error. There is a predefined set of error detail types 729 # in the package `google.rpc` that can be used for common error conditions. 730 # 731 # # Language mapping 732 # 733 # The `Status` message is the logical representation of the error model, but it 734 # is not necessarily the actual wire format. When the `Status` message is 735 # exposed in different client libraries and different wire protocols, it can be 736 # mapped differently. For example, it will likely be mapped to some exceptions 737 # in Java, but more likely mapped to some error codes in C. 738 # 739 # # Other uses 740 # 741 # The error model and the `Status` message can be used in a variety of 742 # environments, either with or without APIs, to provide a 743 # consistent developer experience across different environments. 744 # 745 # Example uses of this error model include: 746 # 747 # - Partial errors. If a service needs to return partial errors to the client, 748 # it may embed the `Status` in the normal response to indicate the partial 749 # errors. 750 # 751 # - Workflow errors. A typical workflow has multiple steps. Each step may 752 # have a `Status` message for error reporting. 753 # 754 # - Batch operations. If a client uses batch request and batch response, the 755 # `Status` message should be used directly inside batch response, one for 756 # each error sub-response. 757 # 758 # - Asynchronous operations. If an API call embeds asynchronous operation 759 # results in its response, the status of those operations should be 760 # represented directly using the `Status` message. 761 # 762 # - Logging. If some API errors are stored in logs, the message `Status` could 763 # be used directly after any stripping needed for security/privacy reasons. 764 "message": "A String", # A developer-facing error message, which should be in English. Any 765 # user-facing error message should be localized and sent in the 766 # google.rpc.Status.details field, or localized by the client. 767 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 768 "details": [ # A list of messages that carry the error details. There is a common set of 769 # message types for APIs to use. 770 { 771 "a_key": "", # Properties of the object. Contains field @type with type URL. 772 }, 773 ], 774 }, 775 "done": True or False, # If the value is `false`, it means the operation is still in progress. 776 # If `true`, the operation is completed, and either `error` or `response` is 777 # available. 778 "response": { # The normal response of the operation in case of success. If the original 779 # method returns no data on success, such as `Delete`, the response is 780 # `google.protobuf.Empty`. If the original method is standard 781 # `Get`/`Create`/`Update`, the response should be the resource. For other 782 # methods, the response should have the type `XxxResponse`, where `Xxx` 783 # is the original method name. For example, if the original method name 784 # is `TakeSnapshot()`, the inferred response type is 785 # `TakeSnapshotResponse`. 786 "a_key": "", # Properties of the object. Contains field @type with type URL. 787 }, 788 "name": "A String", # The server-assigned name, which is only unique within the same service that 789 # originally returns it. If you use the default HTTP mapping, the 790 # `name` should have the format of `operations/some/unique/name`. 791 }</pre> 792</div> 793 794<div class="method"> 795 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code> 796 <pre>Sets the access control policy on an instance resource. Replaces any 797existing policy. 798 799Args: 800 resource: string, REQUIRED: The resource for which the policy is being specified. 801See the operation documentation for the appropriate value for this field. (required) 802 body: object, The request body. (required) 803 The object takes the form of: 804 805{ # Request message for `SetIamPolicy` method. 806 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of 807 # the policy is limited to a few 10s of KB. An empty policy is a 808 # valid policy but certain Cloud Platform services (such as Projects) 809 # might reject them. 810 # specify access control policies for Cloud Platform resources. 811 # 812 # 813 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 814 # `members` to a `role`, where the members can be user accounts, Google groups, 815 # Google domains, and service accounts. A `role` is a named list of permissions 816 # defined by IAM. 817 # 818 # **JSON Example** 819 # 820 # { 821 # "bindings": [ 822 # { 823 # "role": "roles/owner", 824 # "members": [ 825 # "user:mike@example.com", 826 # "group:admins@example.com", 827 # "domain:google.com", 828 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 829 # ] 830 # }, 831 # { 832 # "role": "roles/viewer", 833 # "members": ["user:sean@example.com"] 834 # } 835 # ] 836 # } 837 # 838 # **YAML Example** 839 # 840 # bindings: 841 # - members: 842 # - user:mike@example.com 843 # - group:admins@example.com 844 # - domain:google.com 845 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 846 # role: roles/owner 847 # - members: 848 # - user:sean@example.com 849 # role: roles/viewer 850 # 851 # 852 # For a description of IAM and its features, see the 853 # [IAM developer's guide](https://cloud.google.com/iam/docs). 854 "bindings": [ # Associates a list of `members` to a `role`. 855 # `bindings` with no members will result in an error. 856 { # Associates `members` with a `role`. 857 "role": "A String", # Role that is assigned to `members`. 858 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 859 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 860 # NOTE: An unsatisfied condition will not allow user access via current 861 # binding. Different bindings, including their conditions, are examined 862 # independently. 863 # 864 # title: "User account presence" 865 # description: "Determines whether the request has a user account" 866 # expression: "size(request.user) > 0" 867 "description": "A String", # An optional description of the expression. This is a longer text which 868 # describes the expression, e.g. when hovered over it in a UI. 869 "expression": "A String", # Textual representation of an expression in 870 # Common Expression Language syntax. 871 # 872 # The application context of the containing message determines which 873 # well-known feature set of CEL is supported. 874 "location": "A String", # An optional string indicating the location of the expression for error 875 # reporting, e.g. a file name and a position in the file. 876 "title": "A String", # An optional title for the expression, i.e. a short string describing 877 # its purpose. This can be used e.g. in UIs which allow to enter the 878 # expression. 879 }, 880 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 881 # `members` can have the following values: 882 # 883 # * `allUsers`: A special identifier that represents anyone who is 884 # on the internet; with or without a Google account. 885 # 886 # * `allAuthenticatedUsers`: A special identifier that represents anyone 887 # who is authenticated with a Google account or a service account. 888 # 889 # * `user:{emailid}`: An email address that represents a specific Google 890 # account. For example, `alice@gmail.com` . 891 # 892 # 893 # * `serviceAccount:{emailid}`: An email address that represents a service 894 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 895 # 896 # * `group:{emailid}`: An email address that represents a Google group. 897 # For example, `admins@example.com`. 898 # 899 # 900 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 901 # users of that domain. For example, `google.com` or `example.com`. 902 # 903 "A String", 904 ], 905 }, 906 ], 907 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 908 { # Specifies the audit configuration for a service. 909 # The configuration determines which permission types are logged, and what 910 # identities, if any, are exempted from logging. 911 # An AuditConfig must have one or more AuditLogConfigs. 912 # 913 # If there are AuditConfigs for both `allServices` and a specific service, 914 # the union of the two AuditConfigs is used for that service: the log_types 915 # specified in each AuditConfig are enabled, and the exempted_members in each 916 # AuditLogConfig are exempted. 917 # 918 # Example Policy with multiple AuditConfigs: 919 # 920 # { 921 # "audit_configs": [ 922 # { 923 # "service": "allServices" 924 # "audit_log_configs": [ 925 # { 926 # "log_type": "DATA_READ", 927 # "exempted_members": [ 928 # "user:foo@gmail.com" 929 # ] 930 # }, 931 # { 932 # "log_type": "DATA_WRITE", 933 # }, 934 # { 935 # "log_type": "ADMIN_READ", 936 # } 937 # ] 938 # }, 939 # { 940 # "service": "fooservice.googleapis.com" 941 # "audit_log_configs": [ 942 # { 943 # "log_type": "DATA_READ", 944 # }, 945 # { 946 # "log_type": "DATA_WRITE", 947 # "exempted_members": [ 948 # "user:bar@gmail.com" 949 # ] 950 # } 951 # ] 952 # } 953 # ] 954 # } 955 # 956 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 957 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 958 # bar@gmail.com from DATA_WRITE logging. 959 "auditLogConfigs": [ # The configuration for logging of each type of permission. 960 { # Provides the configuration for logging a type of permissions. 961 # Example: 962 # 963 # { 964 # "audit_log_configs": [ 965 # { 966 # "log_type": "DATA_READ", 967 # "exempted_members": [ 968 # "user:foo@gmail.com" 969 # ] 970 # }, 971 # { 972 # "log_type": "DATA_WRITE", 973 # } 974 # ] 975 # } 976 # 977 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 978 # foo@gmail.com from DATA_READ logging. 979 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 980 # permission. 981 # Follows the same format of Binding.members. 982 "A String", 983 ], 984 "logType": "A String", # The log type that this config enables. 985 }, 986 ], 987 "service": "A String", # Specifies a service that will be enabled for audit logging. 988 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 989 # `allServices` is a special value that covers all services. 990 }, 991 ], 992 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 993 # prevent simultaneous updates of a policy from overwriting each other. 994 # It is strongly suggested that systems make use of the `etag` in the 995 # read-modify-write cycle to perform policy updates in order to avoid race 996 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 997 # systems are expected to put that etag in the request to `setIamPolicy` to 998 # ensure that their change will be applied to the same version of the policy. 999 # 1000 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 1001 # policy is overwritten blindly. 1002 "version": 42, # Deprecated. 1003 }, 1004 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only 1005 # the fields in the mask will be modified. If no mask is provided, the 1006 # following default mask is used: 1007 # paths: "bindings, etag" 1008 # This field is only used by Cloud IAM. 1009 } 1010 1011 x__xgafv: string, V1 error format. 1012 Allowed values 1013 1 - v1 error format 1014 2 - v2 error format 1015 1016Returns: 1017 An object of the form: 1018 1019 { # Defines an Identity and Access Management (IAM) policy. It is used to 1020 # specify access control policies for Cloud Platform resources. 1021 # 1022 # 1023 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 1024 # `members` to a `role`, where the members can be user accounts, Google groups, 1025 # Google domains, and service accounts. A `role` is a named list of permissions 1026 # defined by IAM. 1027 # 1028 # **JSON Example** 1029 # 1030 # { 1031 # "bindings": [ 1032 # { 1033 # "role": "roles/owner", 1034 # "members": [ 1035 # "user:mike@example.com", 1036 # "group:admins@example.com", 1037 # "domain:google.com", 1038 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 1039 # ] 1040 # }, 1041 # { 1042 # "role": "roles/viewer", 1043 # "members": ["user:sean@example.com"] 1044 # } 1045 # ] 1046 # } 1047 # 1048 # **YAML Example** 1049 # 1050 # bindings: 1051 # - members: 1052 # - user:mike@example.com 1053 # - group:admins@example.com 1054 # - domain:google.com 1055 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 1056 # role: roles/owner 1057 # - members: 1058 # - user:sean@example.com 1059 # role: roles/viewer 1060 # 1061 # 1062 # For a description of IAM and its features, see the 1063 # [IAM developer's guide](https://cloud.google.com/iam/docs). 1064 "bindings": [ # Associates a list of `members` to a `role`. 1065 # `bindings` with no members will result in an error. 1066 { # Associates `members` with a `role`. 1067 "role": "A String", # Role that is assigned to `members`. 1068 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1069 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 1070 # NOTE: An unsatisfied condition will not allow user access via current 1071 # binding. Different bindings, including their conditions, are examined 1072 # independently. 1073 # 1074 # title: "User account presence" 1075 # description: "Determines whether the request has a user account" 1076 # expression: "size(request.user) > 0" 1077 "description": "A String", # An optional description of the expression. This is a longer text which 1078 # describes the expression, e.g. when hovered over it in a UI. 1079 "expression": "A String", # Textual representation of an expression in 1080 # Common Expression Language syntax. 1081 # 1082 # The application context of the containing message determines which 1083 # well-known feature set of CEL is supported. 1084 "location": "A String", # An optional string indicating the location of the expression for error 1085 # reporting, e.g. a file name and a position in the file. 1086 "title": "A String", # An optional title for the expression, i.e. a short string describing 1087 # its purpose. This can be used e.g. in UIs which allow to enter the 1088 # expression. 1089 }, 1090 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 1091 # `members` can have the following values: 1092 # 1093 # * `allUsers`: A special identifier that represents anyone who is 1094 # on the internet; with or without a Google account. 1095 # 1096 # * `allAuthenticatedUsers`: A special identifier that represents anyone 1097 # who is authenticated with a Google account or a service account. 1098 # 1099 # * `user:{emailid}`: An email address that represents a specific Google 1100 # account. For example, `alice@gmail.com` . 1101 # 1102 # 1103 # * `serviceAccount:{emailid}`: An email address that represents a service 1104 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 1105 # 1106 # * `group:{emailid}`: An email address that represents a Google group. 1107 # For example, `admins@example.com`. 1108 # 1109 # 1110 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 1111 # users of that domain. For example, `google.com` or `example.com`. 1112 # 1113 "A String", 1114 ], 1115 }, 1116 ], 1117 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1118 { # Specifies the audit configuration for a service. 1119 # The configuration determines which permission types are logged, and what 1120 # identities, if any, are exempted from logging. 1121 # An AuditConfig must have one or more AuditLogConfigs. 1122 # 1123 # If there are AuditConfigs for both `allServices` and a specific service, 1124 # the union of the two AuditConfigs is used for that service: the log_types 1125 # specified in each AuditConfig are enabled, and the exempted_members in each 1126 # AuditLogConfig are exempted. 1127 # 1128 # Example Policy with multiple AuditConfigs: 1129 # 1130 # { 1131 # "audit_configs": [ 1132 # { 1133 # "service": "allServices" 1134 # "audit_log_configs": [ 1135 # { 1136 # "log_type": "DATA_READ", 1137 # "exempted_members": [ 1138 # "user:foo@gmail.com" 1139 # ] 1140 # }, 1141 # { 1142 # "log_type": "DATA_WRITE", 1143 # }, 1144 # { 1145 # "log_type": "ADMIN_READ", 1146 # } 1147 # ] 1148 # }, 1149 # { 1150 # "service": "fooservice.googleapis.com" 1151 # "audit_log_configs": [ 1152 # { 1153 # "log_type": "DATA_READ", 1154 # }, 1155 # { 1156 # "log_type": "DATA_WRITE", 1157 # "exempted_members": [ 1158 # "user:bar@gmail.com" 1159 # ] 1160 # } 1161 # ] 1162 # } 1163 # ] 1164 # } 1165 # 1166 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 1167 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 1168 # bar@gmail.com from DATA_WRITE logging. 1169 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1170 { # Provides the configuration for logging a type of permissions. 1171 # Example: 1172 # 1173 # { 1174 # "audit_log_configs": [ 1175 # { 1176 # "log_type": "DATA_READ", 1177 # "exempted_members": [ 1178 # "user:foo@gmail.com" 1179 # ] 1180 # }, 1181 # { 1182 # "log_type": "DATA_WRITE", 1183 # } 1184 # ] 1185 # } 1186 # 1187 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 1188 # foo@gmail.com from DATA_READ logging. 1189 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 1190 # permission. 1191 # Follows the same format of Binding.members. 1192 "A String", 1193 ], 1194 "logType": "A String", # The log type that this config enables. 1195 }, 1196 ], 1197 "service": "A String", # Specifies a service that will be enabled for audit logging. 1198 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 1199 # `allServices` is a special value that covers all services. 1200 }, 1201 ], 1202 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 1203 # prevent simultaneous updates of a policy from overwriting each other. 1204 # It is strongly suggested that systems make use of the `etag` in the 1205 # read-modify-write cycle to perform policy updates in order to avoid race 1206 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 1207 # systems are expected to put that etag in the request to `setIamPolicy` to 1208 # ensure that their change will be applied to the same version of the policy. 1209 # 1210 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 1211 # policy is overwritten blindly. 1212 "version": 42, # Deprecated. 1213 }</pre> 1214</div> 1215 1216<div class="method"> 1217 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code> 1218 <pre>Returns permissions that the caller has on the specified instance resource. 1219 1220Args: 1221 resource: string, REQUIRED: The resource for which the policy detail is being requested. 1222See the operation documentation for the appropriate value for this field. (required) 1223 body: object, The request body. (required) 1224 The object takes the form of: 1225 1226{ # Request message for `TestIamPermissions` method. 1227 "permissions": [ # The set of permissions to check for the `resource`. Permissions with 1228 # wildcards (such as '*' or 'storage.*') are not allowed. For more 1229 # information see 1230 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 1231 "A String", 1232 ], 1233 } 1234 1235 x__xgafv: string, V1 error format. 1236 Allowed values 1237 1 - v1 error format 1238 2 - v2 error format 1239 1240Returns: 1241 An object of the form: 1242 1243 { # Response message for `TestIamPermissions` method. 1244 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is 1245 # allowed. 1246 "A String", 1247 ], 1248 }</pre> 1249</div> 1250 1251<div class="method"> 1252 <code class="details" id="update">update(name, body, x__xgafv=None)</code> 1253 <pre>Updates an instance within a project. This method updates only the display 1254name and type for an Instance. To update other Instance properties, such as 1255labels, use PartialUpdateInstance. 1256 1257Args: 1258 name: string, (`OutputOnly`) 1259The unique name of the instance. Values are of the form 1260`projects/<project>/instances/a-z+[a-z0-9]`. (required) 1261 body: object, The request body. (required) 1262 The object takes the form of: 1263 1264{ # A collection of Bigtable Tables and 1265 # the resources that serve them. 1266 # All tables in an instance are served from all 1267 # Clusters in the instance. 1268 "type": "A String", # The type of the instance. Defaults to `PRODUCTION`. 1269 "state": "A String", # (`OutputOnly`) 1270 # The current state of the instance. 1271 "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud 1272 # resources into groups that reflect a customer's organizational needs and 1273 # deployment strategies. They can be used to filter resources and aggregate 1274 # metrics. 1275 # 1276 # * Label keys must be between 1 and 63 characters long and must conform to 1277 # the regular expression: `\p{Ll}\p{Lo}{0,62}`. 1278 # * Label values must be between 0 and 63 characters long and must conform to 1279 # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. 1280 # * No more than 64 labels can be associated with a given resource. 1281 # * Keys and values must both be under 128 bytes. 1282 "a_key": "A String", 1283 }, 1284 "displayName": "A String", # The descriptive name for this instance as it appears in UIs. 1285 # Can be changed at any time, but should be kept globally unique 1286 # to avoid confusion. 1287 "name": "A String", # (`OutputOnly`) 1288 # The unique name of the instance. Values are of the form 1289 # `projects/<project>/instances/a-z+[a-z0-9]`. 1290} 1291 1292 x__xgafv: string, V1 error format. 1293 Allowed values 1294 1 - v1 error format 1295 2 - v2 error format 1296 1297Returns: 1298 An object of the form: 1299 1300 { # A collection of Bigtable Tables and 1301 # the resources that serve them. 1302 # All tables in an instance are served from all 1303 # Clusters in the instance. 1304 "type": "A String", # The type of the instance. Defaults to `PRODUCTION`. 1305 "state": "A String", # (`OutputOnly`) 1306 # The current state of the instance. 1307 "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud 1308 # resources into groups that reflect a customer's organizational needs and 1309 # deployment strategies. They can be used to filter resources and aggregate 1310 # metrics. 1311 # 1312 # * Label keys must be between 1 and 63 characters long and must conform to 1313 # the regular expression: `\p{Ll}\p{Lo}{0,62}`. 1314 # * Label values must be between 0 and 63 characters long and must conform to 1315 # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. 1316 # * No more than 64 labels can be associated with a given resource. 1317 # * Keys and values must both be under 128 bytes. 1318 "a_key": "A String", 1319 }, 1320 "displayName": "A String", # The descriptive name for this instance as it appears in UIs. 1321 # Can be changed at any time, but should be kept globally unique 1322 # to avoid confusion. 1323 "name": "A String", # (`OutputOnly`) 1324 # The unique name of the instance. Values are of the form 1325 # `projects/<project>/instances/a-z+[a-z0-9]`. 1326 }</pre> 1327</div> 1328 1329</body></html>