| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 111 | <code><a href="#partialUpdateInstance">partialUpdateInstance(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 112 | <p class="firstline">Partially updates an instance within a project. This method can modify all</p> |
| 113 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 114 | <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 115 | <p class="firstline">Sets the access control policy on an instance resource. Replaces any</p> |
| 116 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 117 | <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | <p class="firstline">Returns permissions that the caller has on the specified instance resource.</p> |
| 119 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 120 | <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 124 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | <pre>Create an instance within a project. |
| 126 | |
| 127 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 128 | parent: string, Required. The unique name of the project in which to create the new instance. |
| 129 | Values are of the form `projects/{project}`. (required) |
| 130 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 131 | The object takes the form of: |
| 132 | |
| 133 | { # Request message for BigtableInstanceAdmin.CreateInstance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 134 | "instanceId": "A String", # Required. The ID to be used when referring to the new instance within its project, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 135 | # e.g., just `myinstance` rather than |
| 136 | # `projects/myproject/instances/myinstance`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | "clusters": { # Required. The clusters to be created within the instance, mapped by desired |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 138 | # cluster ID, e.g., just `mycluster` rather than |
| 139 | # `projects/myproject/instances/myinstance/clusters/mycluster`. |
| 140 | # Fields marked `OutputOnly` must be left blank. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 141 | # Currently, at most four clusters can be specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | "a_key": { # A resizable group of nodes in a particular cloud location, capable |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 143 | # of serving all Tables in the parent |
| 144 | # Instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 146 | # throughput and more consistent performance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 147 | "defaultStorageType": "A String", # (`CreationOnly`) |
| 148 | # The type of storage used by this cluster to serve its |
| 149 | # parent instance's tables, unless explicitly overridden. |
| 150 | "location": "A String", # (`CreationOnly`) |
| 151 | # The location where this cluster's nodes and storage reside. For best |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 152 | # performance, clients should be located as close as possible to this |
| 153 | # cluster. Currently only zones are supported, so values should be of the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 154 | # form `projects/{project}/locations/{zone}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 155 | "state": "A String", # (`OutputOnly`) |
| 156 | # The current state of the cluster. |
| 157 | "name": "A String", # Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 158 | # The unique name of the cluster. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 159 | # `projects/{project}/instances/{instance}/clusters/a-z*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 160 | }, |
| 161 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "instance": { # A collection of Bigtable Tables and # Required. The instance to create. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 163 | # Fields marked `OutputOnly` must be left blank. |
| 164 | # the resources that serve them. |
| 165 | # All tables in an instance are served from all |
| 166 | # Clusters in the instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 167 | "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. |
| 168 | "labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud |
| 169 | # resources into groups that reflect a customer's organizational needs and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 170 | # deployment strategies. They can be used to filter resources and aggregate |
| 171 | # metrics. |
| 172 | # |
| 173 | # * Label keys must be between 1 and 63 characters long and must conform to |
| 174 | # the regular expression: `\p{Ll}\p{Lo}{0,62}`. |
| 175 | # * Label values must be between 0 and 63 characters long and must conform to |
| 176 | # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. |
| 177 | # * No more than 64 labels can be associated with a given resource. |
| 178 | # * Keys and values must both be under 128 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 179 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 180 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | "state": "A String", # (`OutputOnly`) |
| 182 | # The current state of the instance. |
| 183 | "name": "A String", # Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 184 | # The unique name of the instance. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 185 | # `projects/{project}/instances/a-z+[a-z0-9]`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 186 | "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. |
| 187 | # Can be changed at any time, but should be kept globally unique |
| 188 | # to avoid confusion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 189 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 190 | "parent": "A String", # Required. The unique name of the project in which to create the new instance. |
| 191 | # Values are of the form `projects/{project}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 192 | } |
| 193 | |
| 194 | x__xgafv: string, V1 error format. |
| 195 | Allowed values |
| 196 | 1 - v1 error format |
| 197 | 2 - v2 error format |
| 198 | |
| 199 | Returns: |
| 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 211 | # If `true`, the operation is completed, and either `error` or `response` is |
| 212 | # available. |
| 213 | "response": { # The normal response of the operation in case of success. If the original |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 214 | # method returns no data on success, such as `Delete`, the response is |
| 215 | # `google.protobuf.Empty`. If the original method is standard |
| 216 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 217 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 218 | # is the original method name. For example, if the original method name |
| 219 | # is `TakeSnapshot()`, the inferred response type is |
| 220 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 221 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 222 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 223 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 224 | # originally returns it. If you use the default HTTP mapping, the |
| 225 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 226 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 227 | # different programming environments, including REST APIs and RPC APIs. It is |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 228 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 229 | # three pieces of data: error code, error message, and error details. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 230 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 231 | # You can find out more about this error model and how to work with it in the |
| 232 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 233 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 234 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 235 | # user-facing error message should be localized and sent in the |
| 236 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 238 | # message types for APIs to use. |
| 239 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 240 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 241 | }, |
| 242 | ], |
| 243 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 244 | }</pre> |
| 245 | </div> |
| 246 | |
| 247 | <div class="method"> |
| 248 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 249 | <pre>Delete an instance from a project. |
| 250 | |
| 251 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 252 | name: string, Required. The unique name of the instance to be deleted. |
| 253 | Values are of the form `projects/{project}/instances/{instance}`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 254 | x__xgafv: string, V1 error format. |
| 255 | Allowed values |
| 256 | 1 - v1 error format |
| 257 | 2 - v2 error format |
| 258 | |
| 259 | Returns: |
| 260 | An object of the form: |
| 261 | |
| 262 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 263 | # empty messages in your APIs. A typical example is to use it as the request |
| 264 | # or the response type of an API method. For instance: |
| 265 | # |
| 266 | # service Foo { |
| 267 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 268 | # } |
| 269 | # |
| 270 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 271 | }</pre> |
| 272 | </div> |
| 273 | |
| 274 | <div class="method"> |
| 275 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 276 | <pre>Gets information about an instance. |
| 277 | |
| 278 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 279 | name: string, Required. The unique name of the requested instance. Values are of the form |
| 280 | `projects/{project}/instances/{instance}`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 281 | x__xgafv: string, V1 error format. |
| 282 | Allowed values |
| 283 | 1 - v1 error format |
| 284 | 2 - v2 error format |
| 285 | |
| 286 | Returns: |
| 287 | An object of the form: |
| 288 | |
| 289 | { # A collection of Bigtable Tables and |
| 290 | # the resources that serve them. |
| 291 | # All tables in an instance are served from all |
| 292 | # Clusters in the instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 293 | "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. |
| 294 | "labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud |
| 295 | # resources into groups that reflect a customer's organizational needs and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 296 | # deployment strategies. They can be used to filter resources and aggregate |
| 297 | # metrics. |
| 298 | # |
| 299 | # * Label keys must be between 1 and 63 characters long and must conform to |
| 300 | # the regular expression: `\p{Ll}\p{Lo}{0,62}`. |
| 301 | # * Label values must be between 0 and 63 characters long and must conform to |
| 302 | # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. |
| 303 | # * No more than 64 labels can be associated with a given resource. |
| 304 | # * Keys and values must both be under 128 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 306 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | "state": "A String", # (`OutputOnly`) |
| 308 | # The current state of the instance. |
| 309 | "name": "A String", # Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 310 | # The unique name of the instance. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 311 | # `projects/{project}/instances/a-z+[a-z0-9]`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 312 | "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. |
| 313 | # Can be changed at any time, but should be kept globally unique |
| 314 | # to avoid confusion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 315 | }</pre> |
| 316 | </div> |
| 317 | |
| 318 | <div class="method"> |
| 319 | <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> |
| 320 | <pre>Gets the access control policy for an instance resource. Returns an empty |
| 321 | policy if an instance exists but does not have a policy set. |
| 322 | |
| 323 | Args: |
| 324 | resource: string, REQUIRED: The resource for which the policy is being requested. |
| 325 | See the operation documentation for the appropriate value for this field. (required) |
| 326 | body: object, The request body. |
| 327 | The object takes the form of: |
| 328 | |
| 329 | { # Request message for `GetIamPolicy` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 330 | "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 331 | # `GetIamPolicy`. This field is only used by Cloud IAM. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 332 | "requestedPolicyVersion": 42, # Optional. The policy format version to be returned. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 333 | # |
| 334 | # Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| 335 | # rejected. |
| 336 | # |
| 337 | # Requests for policies with any conditional bindings must specify version 3. |
| 338 | # Policies without any conditional bindings may specify any valid value or |
| 339 | # leave the field unset. |
| 340 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 341 | } |
| 342 | |
| 343 | x__xgafv: string, V1 error format. |
| 344 | Allowed values |
| 345 | 1 - v1 error format |
| 346 | 2 - v2 error format |
| 347 | |
| 348 | Returns: |
| 349 | An object of the form: |
| 350 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 351 | { # An Identity and Access Management (IAM) policy, which specifies access |
| 352 | # controls for Google Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 353 | # |
| 354 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 355 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 356 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 357 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 358 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 359 | # custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 360 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 361 | # Optionally, a `binding` can specify a `condition`, which is a logical |
| 362 | # expression that allows access to a resource only if the expression evaluates |
| 363 | # to `true`. A condition can add constraints based on attributes of the |
| 364 | # request, the resource, or both. |
| 365 | # |
| 366 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 367 | # |
| 368 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 369 | # "bindings": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 370 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 371 | # "role": "roles/resourcemanager.organizationAdmin", |
| 372 | # "members": [ |
| 373 | # "user:mike@example.com", |
| 374 | # "group:admins@example.com", |
| 375 | # "domain:google.com", |
| 376 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 377 | # ] |
| 378 | # }, |
| 379 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 380 | # "role": "roles/resourcemanager.organizationViewer", |
| 381 | # "members": ["user:eve@example.com"], |
| 382 | # "condition": { |
| 383 | # "title": "expirable access", |
| 384 | # "description": "Does not grant access after Sep 2020", |
| 385 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 386 | # } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 387 | # } |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 388 | # ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 389 | # "etag": "BwWWja0YfJA=", |
| 390 | # "version": 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 391 | # } |
| 392 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 393 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 394 | # |
| 395 | # bindings: |
| 396 | # - members: |
| 397 | # - user:mike@example.com |
| 398 | # - group:admins@example.com |
| 399 | # - domain:google.com |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 400 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 401 | # role: roles/resourcemanager.organizationAdmin |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 402 | # - members: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 403 | # - user:eve@example.com |
| 404 | # role: roles/resourcemanager.organizationViewer |
| 405 | # condition: |
| 406 | # title: expirable access |
| 407 | # description: Does not grant access after Sep 2020 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 408 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 409 | # - etag: BwWWja0YfJA= |
| 410 | # - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 411 | # |
| 412 | # For a description of IAM and its features, see the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 413 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 414 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 415 | # prevent simultaneous updates of a policy from overwriting each other. |
| 416 | # It is strongly suggested that systems make use of the `etag` in the |
| 417 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 418 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 419 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 420 | # ensure that their change will be applied to the same version of the policy. |
| 421 | # |
| 422 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 423 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 424 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 425 | # the conditions in the version `3` policy are lost. |
| 426 | "version": 42, # Specifies the format of the policy. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 427 | # |
| 428 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 429 | # are rejected. |
| 430 | # |
| 431 | # Any operation that affects conditional role bindings must specify version |
| 432 | # `3`. This requirement applies to the following operations: |
| 433 | # |
| 434 | # * Getting a policy that includes a conditional role binding |
| 435 | # * Adding a conditional role binding to a policy |
| 436 | # * Changing a conditional role binding in a policy |
| 437 | # * Removing any role binding, with or without a condition, from a policy |
| 438 | # that includes conditions |
| 439 | # |
| 440 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 441 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 442 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 443 | # the conditions in the version `3` policy are lost. |
| 444 | # |
| 445 | # If a policy does not include any conditions, operations on that policy may |
| 446 | # specify any valid version or leave the field unset. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 447 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 448 | { # Specifies the audit configuration for a service. |
| 449 | # The configuration determines which permission types are logged, and what |
| 450 | # identities, if any, are exempted from logging. |
| 451 | # An AuditConfig must have one or more AuditLogConfigs. |
| 452 | # |
| 453 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 454 | # the union of the two AuditConfigs is used for that service: the log_types |
| 455 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 456 | # AuditLogConfig are exempted. |
| 457 | # |
| 458 | # Example Policy with multiple AuditConfigs: |
| 459 | # |
| 460 | # { |
| 461 | # "audit_configs": [ |
| 462 | # { |
| 463 | # "service": "allServices" |
| 464 | # "audit_log_configs": [ |
| 465 | # { |
| 466 | # "log_type": "DATA_READ", |
| 467 | # "exempted_members": [ |
| 468 | # "user:jose@example.com" |
| 469 | # ] |
| 470 | # }, |
| 471 | # { |
| 472 | # "log_type": "DATA_WRITE", |
| 473 | # }, |
| 474 | # { |
| 475 | # "log_type": "ADMIN_READ", |
| 476 | # } |
| 477 | # ] |
| 478 | # }, |
| 479 | # { |
| 480 | # "service": "sampleservice.googleapis.com" |
| 481 | # "audit_log_configs": [ |
| 482 | # { |
| 483 | # "log_type": "DATA_READ", |
| 484 | # }, |
| 485 | # { |
| 486 | # "log_type": "DATA_WRITE", |
| 487 | # "exempted_members": [ |
| 488 | # "user:aliya@example.com" |
| 489 | # ] |
| 490 | # } |
| 491 | # ] |
| 492 | # } |
| 493 | # ] |
| 494 | # } |
| 495 | # |
| 496 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 497 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 498 | # aliya@example.com from DATA_WRITE logging. |
| 499 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 500 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 501 | # `allServices` is a special value that covers all services. |
| 502 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 503 | { # Provides the configuration for logging a type of permissions. |
| 504 | # Example: |
| 505 | # |
| 506 | # { |
| 507 | # "audit_log_configs": [ |
| 508 | # { |
| 509 | # "log_type": "DATA_READ", |
| 510 | # "exempted_members": [ |
| 511 | # "user:jose@example.com" |
| 512 | # ] |
| 513 | # }, |
| 514 | # { |
| 515 | # "log_type": "DATA_WRITE", |
| 516 | # } |
| 517 | # ] |
| 518 | # } |
| 519 | # |
| 520 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 521 | # jose@example.com from DATA_READ logging. |
| 522 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 523 | # permission. |
| 524 | # Follows the same format of Binding.members. |
| 525 | "A String", |
| 526 | ], |
| 527 | "logType": "A String", # The log type that this config enables. |
| 528 | }, |
| 529 | ], |
| 530 | }, |
| 531 | ], |
| 532 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 533 | # `condition` that determines how and when the `bindings` are applied. Each |
| 534 | # of the `bindings` must contain at least one member. |
| 535 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 536 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 537 | # NOTE: An unsatisfied condition will not allow user access via current |
| 538 | # binding. Different bindings, including their conditions, are examined |
| 539 | # independently. |
| 540 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 541 | # are documented at https://github.com/google/cel-spec. |
| 542 | # |
| 543 | # Example (Comparison): |
| 544 | # |
| 545 | # title: "Summary size limit" |
| 546 | # description: "Determines if a summary is less than 100 chars" |
| 547 | # expression: "document.summary.size() < 100" |
| 548 | # |
| 549 | # Example (Equality): |
| 550 | # |
| 551 | # title: "Requestor is owner" |
| 552 | # description: "Determines if requestor is the document owner" |
| 553 | # expression: "document.owner == request.auth.claims.email" |
| 554 | # |
| 555 | # Example (Logic): |
| 556 | # |
| 557 | # title: "Public documents" |
| 558 | # description: "Determine whether the document should be publicly visible" |
| 559 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 560 | # |
| 561 | # Example (Data Manipulation): |
| 562 | # |
| 563 | # title: "Notification string" |
| 564 | # description: "Create a notification string with a timestamp." |
| 565 | # expression: "'New message received at ' + string(document.create_time)" |
| 566 | # |
| 567 | # The exact variables and functions that may be referenced within an expression |
| 568 | # are determined by the service that evaluates it. See the service |
| 569 | # documentation for additional information. |
| 570 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 571 | # describes the expression, e.g. when hovered over it in a UI. |
| 572 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 573 | # syntax. |
| 574 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 575 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 576 | # expression. |
| 577 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 578 | # reporting, e.g. a file name and a position in the file. |
| 579 | }, |
| 580 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 581 | # `members` can have the following values: |
| 582 | # |
| 583 | # * `allUsers`: A special identifier that represents anyone who is |
| 584 | # on the internet; with or without a Google account. |
| 585 | # |
| 586 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 587 | # who is authenticated with a Google account or a service account. |
| 588 | # |
| 589 | # * `user:{emailid}`: An email address that represents a specific Google |
| 590 | # account. For example, `alice@example.com` . |
| 591 | # |
| 592 | # |
| 593 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 594 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 595 | # |
| 596 | # * `group:{emailid}`: An email address that represents a Google group. |
| 597 | # For example, `admins@example.com`. |
| 598 | # |
| 599 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 600 | # identifier) representing a user that has been recently deleted. For |
| 601 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 602 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 603 | # retains the role in the binding. |
| 604 | # |
| 605 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 606 | # unique identifier) representing a service account that has been recently |
| 607 | # deleted. For example, |
| 608 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 609 | # If the service account is undeleted, this value reverts to |
| 610 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 611 | # role in the binding. |
| 612 | # |
| 613 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 614 | # identifier) representing a Google group that has been recently |
| 615 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 616 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 617 | # recovered group retains the role in the binding. |
| 618 | # |
| 619 | # |
| 620 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 621 | # users of that domain. For example, `google.com` or `example.com`. |
| 622 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 623 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 624 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 625 | "role": "A String", # Role that is assigned to `members`. |
| 626 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 627 | }, |
| 628 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 629 | }</pre> |
| 630 | </div> |
| 631 | |
| 632 | <div class="method"> |
| 633 | <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code> |
| 634 | <pre>Lists information about instances in a project. |
| 635 | |
| 636 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 637 | parent: string, Required. The unique name of the project for which a list of instances is requested. |
| 638 | Values are of the form `projects/{project}`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 639 | pageToken: string, DEPRECATED: This field is unused and ignored. |
| 640 | x__xgafv: string, V1 error format. |
| 641 | Allowed values |
| 642 | 1 - v1 error format |
| 643 | 2 - v2 error format |
| 644 | |
| 645 | Returns: |
| 646 | An object of the form: |
| 647 | |
| 648 | { # Response message for BigtableInstanceAdmin.ListInstances. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 649 | "instances": [ # The list of requested instances. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 650 | { # A collection of Bigtable Tables and |
| 651 | # the resources that serve them. |
| 652 | # All tables in an instance are served from all |
| 653 | # Clusters in the instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 654 | "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. |
| 655 | "labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud |
| 656 | # resources into groups that reflect a customer's organizational needs and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 657 | # deployment strategies. They can be used to filter resources and aggregate |
| 658 | # metrics. |
| 659 | # |
| 660 | # * Label keys must be between 1 and 63 characters long and must conform to |
| 661 | # the regular expression: `\p{Ll}\p{Lo}{0,62}`. |
| 662 | # * Label values must be between 0 and 63 characters long and must conform to |
| 663 | # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. |
| 664 | # * No more than 64 labels can be associated with a given resource. |
| 665 | # * Keys and values must both be under 128 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 666 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 667 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 668 | "state": "A String", # (`OutputOnly`) |
| 669 | # The current state of the instance. |
| 670 | "name": "A String", # Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 671 | # The unique name of the instance. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 672 | # `projects/{project}/instances/a-z+[a-z0-9]`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 673 | "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. |
| 674 | # Can be changed at any time, but should be kept globally unique |
| 675 | # to avoid confusion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 676 | }, |
| 677 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 678 | "failedLocations": [ # Locations from which Instance information could not be retrieved, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 679 | # due to an outage or some other transient condition. |
| 680 | # Instances whose Clusters are all in one of the failed locations |
| 681 | # may be missing from `instances`, and Instances with at least one |
| 682 | # Cluster in a failed location may only have partial information returned. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 683 | # Values are of the form `projects/<project>/locations/<zone_id>` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 684 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 685 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 686 | "nextPageToken": "A String", # DEPRECATED: This field is unused and ignored. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 687 | }</pre> |
| 688 | </div> |
| 689 | |
| 690 | <div class="method"> |
| 691 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 692 | <pre>Retrieves the next page of results. |
| 693 | |
| 694 | Args: |
| 695 | previous_request: The request for the previous page. (required) |
| 696 | previous_response: The response from the request for the previous page. (required) |
| 697 | |
| 698 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 699 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 700 | page. Returns None if there are no more items in the collection. |
| 701 | </pre> |
| 702 | </div> |
| 703 | |
| 704 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 705 | <code class="details" id="partialUpdateInstance">partialUpdateInstance(name, body=None, updateMask=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 706 | <pre>Partially updates an instance within a project. This method can modify all |
| 707 | fields of an Instance and is the preferred way to update an Instance. |
| 708 | |
| 709 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 710 | name: string, Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 711 | The unique name of the instance. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 712 | `projects/{project}/instances/a-z+[a-z0-9]`. (required) |
| 713 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 714 | The object takes the form of: |
| 715 | |
| 716 | { # A collection of Bigtable Tables and |
| 717 | # the resources that serve them. |
| 718 | # All tables in an instance are served from all |
| 719 | # Clusters in the instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 720 | "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. |
| 721 | "labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud |
| 722 | # resources into groups that reflect a customer's organizational needs and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 723 | # deployment strategies. They can be used to filter resources and aggregate |
| 724 | # metrics. |
| 725 | # |
| 726 | # * Label keys must be between 1 and 63 characters long and must conform to |
| 727 | # the regular expression: `\p{Ll}\p{Lo}{0,62}`. |
| 728 | # * Label values must be between 0 and 63 characters long and must conform to |
| 729 | # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. |
| 730 | # * No more than 64 labels can be associated with a given resource. |
| 731 | # * Keys and values must both be under 128 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 732 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 733 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 734 | "state": "A String", # (`OutputOnly`) |
| 735 | # The current state of the instance. |
| 736 | "name": "A String", # Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 737 | # The unique name of the instance. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 738 | # `projects/{project}/instances/a-z+[a-z0-9]`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 739 | "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. |
| 740 | # Can be changed at any time, but should be kept globally unique |
| 741 | # to avoid confusion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 742 | } |
| 743 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 744 | updateMask: string, Required. The subset of Instance fields which should be replaced. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 745 | Must be explicitly set. |
| 746 | x__xgafv: string, V1 error format. |
| 747 | Allowed values |
| 748 | 1 - v1 error format |
| 749 | 2 - v2 error format |
| 750 | |
| 751 | Returns: |
| 752 | An object of the form: |
| 753 | |
| 754 | { # This resource represents a long-running operation that is the result of a |
| 755 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 756 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 757 | # contains progress information and common metadata such as create time. |
| 758 | # Some services might not provide such metadata. Any method that returns a |
| 759 | # long-running operation should document the metadata type, if any. |
| 760 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 761 | }, |
| 762 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 763 | # If `true`, the operation is completed, and either `error` or `response` is |
| 764 | # available. |
| 765 | "response": { # The normal response of the operation in case of success. If the original |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 766 | # method returns no data on success, such as `Delete`, the response is |
| 767 | # `google.protobuf.Empty`. If the original method is standard |
| 768 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 769 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 770 | # is the original method name. For example, if the original method name |
| 771 | # is `TakeSnapshot()`, the inferred response type is |
| 772 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 773 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 774 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 775 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 776 | # originally returns it. If you use the default HTTP mapping, the |
| 777 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 778 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 779 | # different programming environments, including REST APIs and RPC APIs. It is |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 780 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 781 | # three pieces of data: error code, error message, and error details. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 782 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 783 | # You can find out more about this error model and how to work with it in the |
| 784 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 785 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 786 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 787 | # user-facing error message should be localized and sent in the |
| 788 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 789 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 790 | # message types for APIs to use. |
| 791 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 792 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 793 | }, |
| 794 | ], |
| 795 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 796 | }</pre> |
| 797 | </div> |
| 798 | |
| 799 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 800 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 801 | <pre>Sets the access control policy on an instance resource. Replaces any |
| 802 | existing policy. |
| 803 | |
| 804 | Args: |
| 805 | resource: string, REQUIRED: The resource for which the policy is being specified. |
| 806 | See the operation documentation for the appropriate value for this field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 807 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 808 | The object takes the form of: |
| 809 | |
| 810 | { # Request message for `SetIamPolicy` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 811 | "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 812 | # the policy is limited to a few 10s of KB. An empty policy is a |
| 813 | # valid policy but certain Cloud Platform services (such as Projects) |
| 814 | # might reject them. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 815 | # controls for Google Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 816 | # |
| 817 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 818 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 819 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 820 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 821 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 822 | # custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 823 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 824 | # Optionally, a `binding` can specify a `condition`, which is a logical |
| 825 | # expression that allows access to a resource only if the expression evaluates |
| 826 | # to `true`. A condition can add constraints based on attributes of the |
| 827 | # request, the resource, or both. |
| 828 | # |
| 829 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 830 | # |
| 831 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 832 | # "bindings": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 833 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 834 | # "role": "roles/resourcemanager.organizationAdmin", |
| 835 | # "members": [ |
| 836 | # "user:mike@example.com", |
| 837 | # "group:admins@example.com", |
| 838 | # "domain:google.com", |
| 839 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 840 | # ] |
| 841 | # }, |
| 842 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 843 | # "role": "roles/resourcemanager.organizationViewer", |
| 844 | # "members": ["user:eve@example.com"], |
| 845 | # "condition": { |
| 846 | # "title": "expirable access", |
| 847 | # "description": "Does not grant access after Sep 2020", |
| 848 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 849 | # } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 850 | # } |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 851 | # ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 852 | # "etag": "BwWWja0YfJA=", |
| 853 | # "version": 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 854 | # } |
| 855 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 856 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 857 | # |
| 858 | # bindings: |
| 859 | # - members: |
| 860 | # - user:mike@example.com |
| 861 | # - group:admins@example.com |
| 862 | # - domain:google.com |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 863 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 864 | # role: roles/resourcemanager.organizationAdmin |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 865 | # - members: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 866 | # - user:eve@example.com |
| 867 | # role: roles/resourcemanager.organizationViewer |
| 868 | # condition: |
| 869 | # title: expirable access |
| 870 | # description: Does not grant access after Sep 2020 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 871 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 872 | # - etag: BwWWja0YfJA= |
| 873 | # - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 874 | # |
| 875 | # For a description of IAM and its features, see the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 876 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 877 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 878 | # prevent simultaneous updates of a policy from overwriting each other. |
| 879 | # It is strongly suggested that systems make use of the `etag` in the |
| 880 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 881 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 882 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 883 | # ensure that their change will be applied to the same version of the policy. |
| 884 | # |
| 885 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 886 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 887 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 888 | # the conditions in the version `3` policy are lost. |
| 889 | "version": 42, # Specifies the format of the policy. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 890 | # |
| 891 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 892 | # are rejected. |
| 893 | # |
| 894 | # Any operation that affects conditional role bindings must specify version |
| 895 | # `3`. This requirement applies to the following operations: |
| 896 | # |
| 897 | # * Getting a policy that includes a conditional role binding |
| 898 | # * Adding a conditional role binding to a policy |
| 899 | # * Changing a conditional role binding in a policy |
| 900 | # * Removing any role binding, with or without a condition, from a policy |
| 901 | # that includes conditions |
| 902 | # |
| 903 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 904 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 905 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 906 | # the conditions in the version `3` policy are lost. |
| 907 | # |
| 908 | # If a policy does not include any conditions, operations on that policy may |
| 909 | # specify any valid version or leave the field unset. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 910 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 911 | { # Specifies the audit configuration for a service. |
| 912 | # The configuration determines which permission types are logged, and what |
| 913 | # identities, if any, are exempted from logging. |
| 914 | # An AuditConfig must have one or more AuditLogConfigs. |
| 915 | # |
| 916 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 917 | # the union of the two AuditConfigs is used for that service: the log_types |
| 918 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 919 | # AuditLogConfig are exempted. |
| 920 | # |
| 921 | # Example Policy with multiple AuditConfigs: |
| 922 | # |
| 923 | # { |
| 924 | # "audit_configs": [ |
| 925 | # { |
| 926 | # "service": "allServices" |
| 927 | # "audit_log_configs": [ |
| 928 | # { |
| 929 | # "log_type": "DATA_READ", |
| 930 | # "exempted_members": [ |
| 931 | # "user:jose@example.com" |
| 932 | # ] |
| 933 | # }, |
| 934 | # { |
| 935 | # "log_type": "DATA_WRITE", |
| 936 | # }, |
| 937 | # { |
| 938 | # "log_type": "ADMIN_READ", |
| 939 | # } |
| 940 | # ] |
| 941 | # }, |
| 942 | # { |
| 943 | # "service": "sampleservice.googleapis.com" |
| 944 | # "audit_log_configs": [ |
| 945 | # { |
| 946 | # "log_type": "DATA_READ", |
| 947 | # }, |
| 948 | # { |
| 949 | # "log_type": "DATA_WRITE", |
| 950 | # "exempted_members": [ |
| 951 | # "user:aliya@example.com" |
| 952 | # ] |
| 953 | # } |
| 954 | # ] |
| 955 | # } |
| 956 | # ] |
| 957 | # } |
| 958 | # |
| 959 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 960 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 961 | # aliya@example.com from DATA_WRITE logging. |
| 962 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 963 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 964 | # `allServices` is a special value that covers all services. |
| 965 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 966 | { # Provides the configuration for logging a type of permissions. |
| 967 | # Example: |
| 968 | # |
| 969 | # { |
| 970 | # "audit_log_configs": [ |
| 971 | # { |
| 972 | # "log_type": "DATA_READ", |
| 973 | # "exempted_members": [ |
| 974 | # "user:jose@example.com" |
| 975 | # ] |
| 976 | # }, |
| 977 | # { |
| 978 | # "log_type": "DATA_WRITE", |
| 979 | # } |
| 980 | # ] |
| 981 | # } |
| 982 | # |
| 983 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 984 | # jose@example.com from DATA_READ logging. |
| 985 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 986 | # permission. |
| 987 | # Follows the same format of Binding.members. |
| 988 | "A String", |
| 989 | ], |
| 990 | "logType": "A String", # The log type that this config enables. |
| 991 | }, |
| 992 | ], |
| 993 | }, |
| 994 | ], |
| 995 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 996 | # `condition` that determines how and when the `bindings` are applied. Each |
| 997 | # of the `bindings` must contain at least one member. |
| 998 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 999 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 1000 | # NOTE: An unsatisfied condition will not allow user access via current |
| 1001 | # binding. Different bindings, including their conditions, are examined |
| 1002 | # independently. |
| 1003 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 1004 | # are documented at https://github.com/google/cel-spec. |
| 1005 | # |
| 1006 | # Example (Comparison): |
| 1007 | # |
| 1008 | # title: "Summary size limit" |
| 1009 | # description: "Determines if a summary is less than 100 chars" |
| 1010 | # expression: "document.summary.size() < 100" |
| 1011 | # |
| 1012 | # Example (Equality): |
| 1013 | # |
| 1014 | # title: "Requestor is owner" |
| 1015 | # description: "Determines if requestor is the document owner" |
| 1016 | # expression: "document.owner == request.auth.claims.email" |
| 1017 | # |
| 1018 | # Example (Logic): |
| 1019 | # |
| 1020 | # title: "Public documents" |
| 1021 | # description: "Determine whether the document should be publicly visible" |
| 1022 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 1023 | # |
| 1024 | # Example (Data Manipulation): |
| 1025 | # |
| 1026 | # title: "Notification string" |
| 1027 | # description: "Create a notification string with a timestamp." |
| 1028 | # expression: "'New message received at ' + string(document.create_time)" |
| 1029 | # |
| 1030 | # The exact variables and functions that may be referenced within an expression |
| 1031 | # are determined by the service that evaluates it. See the service |
| 1032 | # documentation for additional information. |
| 1033 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 1034 | # describes the expression, e.g. when hovered over it in a UI. |
| 1035 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 1036 | # syntax. |
| 1037 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 1038 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 1039 | # expression. |
| 1040 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 1041 | # reporting, e.g. a file name and a position in the file. |
| 1042 | }, |
| 1043 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1044 | # `members` can have the following values: |
| 1045 | # |
| 1046 | # * `allUsers`: A special identifier that represents anyone who is |
| 1047 | # on the internet; with or without a Google account. |
| 1048 | # |
| 1049 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 1050 | # who is authenticated with a Google account or a service account. |
| 1051 | # |
| 1052 | # * `user:{emailid}`: An email address that represents a specific Google |
| 1053 | # account. For example, `alice@example.com` . |
| 1054 | # |
| 1055 | # |
| 1056 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 1057 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1058 | # |
| 1059 | # * `group:{emailid}`: An email address that represents a Google group. |
| 1060 | # For example, `admins@example.com`. |
| 1061 | # |
| 1062 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1063 | # identifier) representing a user that has been recently deleted. For |
| 1064 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 1065 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 1066 | # retains the role in the binding. |
| 1067 | # |
| 1068 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 1069 | # unique identifier) representing a service account that has been recently |
| 1070 | # deleted. For example, |
| 1071 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 1072 | # If the service account is undeleted, this value reverts to |
| 1073 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 1074 | # role in the binding. |
| 1075 | # |
| 1076 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1077 | # identifier) representing a Google group that has been recently |
| 1078 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 1079 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 1080 | # recovered group retains the role in the binding. |
| 1081 | # |
| 1082 | # |
| 1083 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 1084 | # users of that domain. For example, `google.com` or `example.com`. |
| 1085 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1086 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1087 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1088 | "role": "A String", # Role that is assigned to `members`. |
| 1089 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1090 | }, |
| 1091 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1092 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1093 | "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1094 | # the fields in the mask will be modified. If no mask is provided, the |
| 1095 | # following default mask is used: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1096 | # paths: "bindings, etag" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1097 | # This field is only used by Cloud IAM. |
| 1098 | } |
| 1099 | |
| 1100 | x__xgafv: string, V1 error format. |
| 1101 | Allowed values |
| 1102 | 1 - v1 error format |
| 1103 | 2 - v2 error format |
| 1104 | |
| 1105 | Returns: |
| 1106 | An object of the form: |
| 1107 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1108 | { # An Identity and Access Management (IAM) policy, which specifies access |
| 1109 | # controls for Google Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1110 | # |
| 1111 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1112 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 1113 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 1114 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 1115 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 1116 | # custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1117 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1118 | # Optionally, a `binding` can specify a `condition`, which is a logical |
| 1119 | # expression that allows access to a resource only if the expression evaluates |
| 1120 | # to `true`. A condition can add constraints based on attributes of the |
| 1121 | # request, the resource, or both. |
| 1122 | # |
| 1123 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1124 | # |
| 1125 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1126 | # "bindings": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1127 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1128 | # "role": "roles/resourcemanager.organizationAdmin", |
| 1129 | # "members": [ |
| 1130 | # "user:mike@example.com", |
| 1131 | # "group:admins@example.com", |
| 1132 | # "domain:google.com", |
| 1133 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1134 | # ] |
| 1135 | # }, |
| 1136 | # { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1137 | # "role": "roles/resourcemanager.organizationViewer", |
| 1138 | # "members": ["user:eve@example.com"], |
| 1139 | # "condition": { |
| 1140 | # "title": "expirable access", |
| 1141 | # "description": "Does not grant access after Sep 2020", |
| 1142 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1143 | # } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1144 | # } |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1145 | # ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1146 | # "etag": "BwWWja0YfJA=", |
| 1147 | # "version": 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1148 | # } |
| 1149 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1150 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1151 | # |
| 1152 | # bindings: |
| 1153 | # - members: |
| 1154 | # - user:mike@example.com |
| 1155 | # - group:admins@example.com |
| 1156 | # - domain:google.com |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1157 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 1158 | # role: roles/resourcemanager.organizationAdmin |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1159 | # - members: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1160 | # - user:eve@example.com |
| 1161 | # role: roles/resourcemanager.organizationViewer |
| 1162 | # condition: |
| 1163 | # title: expirable access |
| 1164 | # description: Does not grant access after Sep 2020 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1165 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1166 | # - etag: BwWWja0YfJA= |
| 1167 | # - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1168 | # |
| 1169 | # For a description of IAM and its features, see the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1170 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1171 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 1172 | # prevent simultaneous updates of a policy from overwriting each other. |
| 1173 | # It is strongly suggested that systems make use of the `etag` in the |
| 1174 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 1175 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 1176 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 1177 | # ensure that their change will be applied to the same version of the policy. |
| 1178 | # |
| 1179 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1180 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1181 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1182 | # the conditions in the version `3` policy are lost. |
| 1183 | "version": 42, # Specifies the format of the policy. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1184 | # |
| 1185 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 1186 | # are rejected. |
| 1187 | # |
| 1188 | # Any operation that affects conditional role bindings must specify version |
| 1189 | # `3`. This requirement applies to the following operations: |
| 1190 | # |
| 1191 | # * Getting a policy that includes a conditional role binding |
| 1192 | # * Adding a conditional role binding to a policy |
| 1193 | # * Changing a conditional role binding in a policy |
| 1194 | # * Removing any role binding, with or without a condition, from a policy |
| 1195 | # that includes conditions |
| 1196 | # |
| 1197 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1198 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1199 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1200 | # the conditions in the version `3` policy are lost. |
| 1201 | # |
| 1202 | # If a policy does not include any conditions, operations on that policy may |
| 1203 | # specify any valid version or leave the field unset. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1204 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 1205 | { # Specifies the audit configuration for a service. |
| 1206 | # The configuration determines which permission types are logged, and what |
| 1207 | # identities, if any, are exempted from logging. |
| 1208 | # An AuditConfig must have one or more AuditLogConfigs. |
| 1209 | # |
| 1210 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 1211 | # the union of the two AuditConfigs is used for that service: the log_types |
| 1212 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 1213 | # AuditLogConfig are exempted. |
| 1214 | # |
| 1215 | # Example Policy with multiple AuditConfigs: |
| 1216 | # |
| 1217 | # { |
| 1218 | # "audit_configs": [ |
| 1219 | # { |
| 1220 | # "service": "allServices" |
| 1221 | # "audit_log_configs": [ |
| 1222 | # { |
| 1223 | # "log_type": "DATA_READ", |
| 1224 | # "exempted_members": [ |
| 1225 | # "user:jose@example.com" |
| 1226 | # ] |
| 1227 | # }, |
| 1228 | # { |
| 1229 | # "log_type": "DATA_WRITE", |
| 1230 | # }, |
| 1231 | # { |
| 1232 | # "log_type": "ADMIN_READ", |
| 1233 | # } |
| 1234 | # ] |
| 1235 | # }, |
| 1236 | # { |
| 1237 | # "service": "sampleservice.googleapis.com" |
| 1238 | # "audit_log_configs": [ |
| 1239 | # { |
| 1240 | # "log_type": "DATA_READ", |
| 1241 | # }, |
| 1242 | # { |
| 1243 | # "log_type": "DATA_WRITE", |
| 1244 | # "exempted_members": [ |
| 1245 | # "user:aliya@example.com" |
| 1246 | # ] |
| 1247 | # } |
| 1248 | # ] |
| 1249 | # } |
| 1250 | # ] |
| 1251 | # } |
| 1252 | # |
| 1253 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 1254 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 1255 | # aliya@example.com from DATA_WRITE logging. |
| 1256 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 1257 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 1258 | # `allServices` is a special value that covers all services. |
| 1259 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 1260 | { # Provides the configuration for logging a type of permissions. |
| 1261 | # Example: |
| 1262 | # |
| 1263 | # { |
| 1264 | # "audit_log_configs": [ |
| 1265 | # { |
| 1266 | # "log_type": "DATA_READ", |
| 1267 | # "exempted_members": [ |
| 1268 | # "user:jose@example.com" |
| 1269 | # ] |
| 1270 | # }, |
| 1271 | # { |
| 1272 | # "log_type": "DATA_WRITE", |
| 1273 | # } |
| 1274 | # ] |
| 1275 | # } |
| 1276 | # |
| 1277 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 1278 | # jose@example.com from DATA_READ logging. |
| 1279 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 1280 | # permission. |
| 1281 | # Follows the same format of Binding.members. |
| 1282 | "A String", |
| 1283 | ], |
| 1284 | "logType": "A String", # The log type that this config enables. |
| 1285 | }, |
| 1286 | ], |
| 1287 | }, |
| 1288 | ], |
| 1289 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1290 | # `condition` that determines how and when the `bindings` are applied. Each |
| 1291 | # of the `bindings` must contain at least one member. |
| 1292 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1293 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 1294 | # NOTE: An unsatisfied condition will not allow user access via current |
| 1295 | # binding. Different bindings, including their conditions, are examined |
| 1296 | # independently. |
| 1297 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 1298 | # are documented at https://github.com/google/cel-spec. |
| 1299 | # |
| 1300 | # Example (Comparison): |
| 1301 | # |
| 1302 | # title: "Summary size limit" |
| 1303 | # description: "Determines if a summary is less than 100 chars" |
| 1304 | # expression: "document.summary.size() < 100" |
| 1305 | # |
| 1306 | # Example (Equality): |
| 1307 | # |
| 1308 | # title: "Requestor is owner" |
| 1309 | # description: "Determines if requestor is the document owner" |
| 1310 | # expression: "document.owner == request.auth.claims.email" |
| 1311 | # |
| 1312 | # Example (Logic): |
| 1313 | # |
| 1314 | # title: "Public documents" |
| 1315 | # description: "Determine whether the document should be publicly visible" |
| 1316 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 1317 | # |
| 1318 | # Example (Data Manipulation): |
| 1319 | # |
| 1320 | # title: "Notification string" |
| 1321 | # description: "Create a notification string with a timestamp." |
| 1322 | # expression: "'New message received at ' + string(document.create_time)" |
| 1323 | # |
| 1324 | # The exact variables and functions that may be referenced within an expression |
| 1325 | # are determined by the service that evaluates it. See the service |
| 1326 | # documentation for additional information. |
| 1327 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 1328 | # describes the expression, e.g. when hovered over it in a UI. |
| 1329 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 1330 | # syntax. |
| 1331 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 1332 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 1333 | # expression. |
| 1334 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 1335 | # reporting, e.g. a file name and a position in the file. |
| 1336 | }, |
| 1337 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1338 | # `members` can have the following values: |
| 1339 | # |
| 1340 | # * `allUsers`: A special identifier that represents anyone who is |
| 1341 | # on the internet; with or without a Google account. |
| 1342 | # |
| 1343 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 1344 | # who is authenticated with a Google account or a service account. |
| 1345 | # |
| 1346 | # * `user:{emailid}`: An email address that represents a specific Google |
| 1347 | # account. For example, `alice@example.com` . |
| 1348 | # |
| 1349 | # |
| 1350 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 1351 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1352 | # |
| 1353 | # * `group:{emailid}`: An email address that represents a Google group. |
| 1354 | # For example, `admins@example.com`. |
| 1355 | # |
| 1356 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1357 | # identifier) representing a user that has been recently deleted. For |
| 1358 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 1359 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 1360 | # retains the role in the binding. |
| 1361 | # |
| 1362 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 1363 | # unique identifier) representing a service account that has been recently |
| 1364 | # deleted. For example, |
| 1365 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 1366 | # If the service account is undeleted, this value reverts to |
| 1367 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 1368 | # role in the binding. |
| 1369 | # |
| 1370 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1371 | # identifier) representing a Google group that has been recently |
| 1372 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 1373 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 1374 | # recovered group retains the role in the binding. |
| 1375 | # |
| 1376 | # |
| 1377 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 1378 | # users of that domain. For example, `google.com` or `example.com`. |
| 1379 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1380 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1381 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1382 | "role": "A String", # Role that is assigned to `members`. |
| 1383 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1384 | }, |
| 1385 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1386 | }</pre> |
| 1387 | </div> |
| 1388 | |
| 1389 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1390 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1391 | <pre>Returns permissions that the caller has on the specified instance resource. |
| 1392 | |
| 1393 | Args: |
| 1394 | resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| 1395 | See the operation documentation for the appropriate value for this field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1396 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1397 | The object takes the form of: |
| 1398 | |
| 1399 | { # Request message for `TestIamPermissions` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1400 | "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| 1401 | # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1402 | # information see |
| 1403 | # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1404 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1405 | ], |
| 1406 | } |
| 1407 | |
| 1408 | x__xgafv: string, V1 error format. |
| 1409 | Allowed values |
| 1410 | 1 - v1 error format |
| 1411 | 2 - v2 error format |
| 1412 | |
| 1413 | Returns: |
| 1414 | An object of the form: |
| 1415 | |
| 1416 | { # Response message for `TestIamPermissions` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1417 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1418 | # allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1419 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1420 | ], |
| 1421 | }</pre> |
| 1422 | </div> |
| 1423 | |
| 1424 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1425 | <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1426 | <pre>Updates an instance within a project. This method updates only the display |
| 1427 | name and type for an Instance. To update other Instance properties, such as |
| 1428 | labels, use PartialUpdateInstance. |
| 1429 | |
| 1430 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1431 | name: string, Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1432 | The unique name of the instance. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1433 | `projects/{project}/instances/a-z+[a-z0-9]`. (required) |
| 1434 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1435 | The object takes the form of: |
| 1436 | |
| 1437 | { # A collection of Bigtable Tables and |
| 1438 | # the resources that serve them. |
| 1439 | # All tables in an instance are served from all |
| 1440 | # Clusters in the instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1441 | "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. |
| 1442 | "labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud |
| 1443 | # resources into groups that reflect a customer's organizational needs and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1444 | # deployment strategies. They can be used to filter resources and aggregate |
| 1445 | # metrics. |
| 1446 | # |
| 1447 | # * Label keys must be between 1 and 63 characters long and must conform to |
| 1448 | # the regular expression: `\p{Ll}\p{Lo}{0,62}`. |
| 1449 | # * Label values must be between 0 and 63 characters long and must conform to |
| 1450 | # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. |
| 1451 | # * No more than 64 labels can be associated with a given resource. |
| 1452 | # * Keys and values must both be under 128 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1453 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1454 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1455 | "state": "A String", # (`OutputOnly`) |
| 1456 | # The current state of the instance. |
| 1457 | "name": "A String", # Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1458 | # The unique name of the instance. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1459 | # `projects/{project}/instances/a-z+[a-z0-9]`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1460 | "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. |
| 1461 | # Can be changed at any time, but should be kept globally unique |
| 1462 | # to avoid confusion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1463 | } |
| 1464 | |
| 1465 | x__xgafv: string, V1 error format. |
| 1466 | Allowed values |
| 1467 | 1 - v1 error format |
| 1468 | 2 - v2 error format |
| 1469 | |
| 1470 | Returns: |
| 1471 | An object of the form: |
| 1472 | |
| 1473 | { # A collection of Bigtable Tables and |
| 1474 | # the resources that serve them. |
| 1475 | # All tables in an instance are served from all |
| 1476 | # Clusters in the instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1477 | "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. |
| 1478 | "labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud |
| 1479 | # resources into groups that reflect a customer's organizational needs and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1480 | # deployment strategies. They can be used to filter resources and aggregate |
| 1481 | # metrics. |
| 1482 | # |
| 1483 | # * Label keys must be between 1 and 63 characters long and must conform to |
| 1484 | # the regular expression: `\p{Ll}\p{Lo}{0,62}`. |
| 1485 | # * Label values must be between 0 and 63 characters long and must conform to |
| 1486 | # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. |
| 1487 | # * No more than 64 labels can be associated with a given resource. |
| 1488 | # * Keys and values must both be under 128 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1489 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1490 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1491 | "state": "A String", # (`OutputOnly`) |
| 1492 | # The current state of the instance. |
| 1493 | "name": "A String", # Required. (`OutputOnly`) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1494 | # The unique name of the instance. Values are of the form |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1495 | # `projects/{project}/instances/a-z+[a-z0-9]`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1496 | "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. |
| 1497 | # Can be changed at any time, but should be kept globally unique |
| 1498 | # to avoid confusion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1499 | }</pre> |
| 1500 | </div> |
| 1501 | |
| 1502 | </body></html> |