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