Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / bigtableadmin_v2.projects.instances.tables.html
blob: b4d2661b6babc3d73285010c268499733abb5562 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.tables.html">tables</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#checkConsistency">checkConsistency(name, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Checks replication consistency based on a consistency token, that is, if</p>
80<p class="toc_element">
81 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a new table in the specified instance.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Permanently deletes a specified table and all of its data.</p>
86<p class="toc_element">
87 <code><a href="#dropRowRange">dropRowRange(name, body, x__xgafv=None)</a></code></p>
88<p class="firstline">Permanently drop/delete a row range from a specified table. The request can</p>
89<p class="toc_element">
90 <code><a href="#generateConsistencyToken">generateConsistencyToken(name, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Generates a consistency token for a Table, which can be used in</p>
92<p class="toc_element">
93 <code><a href="#get">get(name, x__xgafv=None, view=None)</a></code></p>
94<p class="firstline">Gets metadata information about the specified table.</p>
95<p class="toc_element">
96 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Gets the access control policy for an instance resource. Returns an empty</p>
98<p class="toc_element">
99 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</a></code></p>
100<p class="firstline">Lists all tables served from a specified instance.</p>
101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<p class="toc_element">
105 <code><a href="#modifyColumnFamilies">modifyColumnFamilies(name, body, x__xgafv=None)</a></code></p>
106<p class="firstline">Performs a series of column family modifications on the specified table.</p>
107<p class="toc_element">
108 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
109<p class="firstline">Sets the access control policy on a table resource. Replaces any existing</p>
110<p class="toc_element">
111 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
112<p class="firstline">Returns permissions that the caller has on the specified table resource.</p>
113<h3>Method Details</h3>
114<div class="method">
115 <code class="details" id="checkConsistency">checkConsistency(name, body, x__xgafv=None)</code>
116 <pre>Checks replication consistency based on a consistency token, that is, if
117replication has caught up based on the conditions specified in the token
118and the check request.
119
120Args:
121 name: string, The unique name of the Table for which to check replication consistency.
122Values are of the form
123`projects/<project>/instances/<instance>/tables/<table>`. (required)
124 body: object, The request body. (required)
125 The object takes the form of:
126
127{ # Request message for
128 # google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
129 "consistencyToken": "A String", # The token created using GenerateConsistencyToken for the Table.
130 }
131
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
140 { # Response message for
141 # google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
142 "consistent": True or False, # True only if the token is consistent. A token is consistent if replication
143 # has caught up with the restrictions specified in the request.
144 }</pre>
145</div>
146
147<div class="method">
148 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
149 <pre>Creates a new table in the specified instance.
150The table can be created with a full set of initial column families,
151specified in the request.
152
153Args:
154 parent: string, The unique name of the instance in which to create the table.
155Values are of the form `projects/<project>/instances/<instance>`. (required)
156 body: object, The request body. (required)
157 The object takes the form of:
158
159{ # Request message for
160 # google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
161 "table": { # A collection of user data indexed by row, column, and timestamp. # The Table to create.
162 # Each table is served using the resources of its parent cluster.
163 "clusterStates": { # Output only.
164 # Map from cluster ID to per-cluster table state.
165 # If it could not be determined whether or not the table has data in a
166 # particular cluster (for example, if its zone is unavailable), then
167 # there will be an entry for the cluster with UNKNOWN `replication_status`.
168 # Views: `REPLICATION_VIEW`, `FULL`
169 "a_key": { # The state of a table's data in a particular cluster.
170 "replicationState": "A String", # Output only.
171 # The state of replication for the table in this cluster.
172 },
173 },
174 "columnFamilies": { # (`CreationOnly`)
175 # The column families configured for this table, mapped by column family ID.
176 # Views: `SCHEMA_VIEW`, `FULL`
177 "a_key": { # A set of columns within a table which share a common configuration.
178 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
179 # Must serialize to at most 500 bytes.
180 #
181 # NOTE: Garbage collection executes opportunistically in the background, and
182 # so it's possible for reads to return a cell even if it matches the active
183 # GC expression for its family.
184 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
185 "rules": [ # Delete cells which would be deleted by any element of `rules`.
186 # Object with schema name: GcRule
187 ],
188 },
189 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
190 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
191 # Object with schema name: GcRule
192 ],
193 },
194 "maxAge": "A String", # Delete cells in a column older than the given age.
195 # Values must be at least one millisecond, and will be truncated to
196 # microsecond granularity.
197 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
198 },
199 },
200 },
201 "name": "A String", # Output only.
202 # The unique name of the table. Values are of the form
203 # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
204 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
205 "granularity": "A String", # (`CreationOnly`)
206 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
207 # this table. Timestamps not matching the granularity will be rejected.
208 # If unspecified at creation time, the value will be set to `MILLIS`.
209 # Views: `SCHEMA_VIEW`, `FULL`.
210 },
211 "initialSplits": [ # The optional list of row keys that will be used to initially split the
212 # table into several tablets (tablets are similar to HBase regions).
213 # Given two split keys, `s1` and `s2`, three tablets will be created,
214 # spanning the key ranges: `[, s1), [s1, s2), [s2, )`.
215 #
216 # Example:
217 #
218 # * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",`
219 # `"other", "zz"]`
220 # * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`
221 # * Key assignment:
222 # - Tablet 1 `[, apple) => {"a"}.`
223 # - Tablet 2 `[apple, customer_1) => {"apple", "custom"}.`
224 # - Tablet 3 `[customer_1, customer_2) => {"customer_1"}.`
225 # - Tablet 4 `[customer_2, other) => {"customer_2"}.`
226 # - Tablet 5 `[other, ) => {"other", "zz"}.`
227 { # An initial split point for a newly created table.
228 "key": "A String", # Row key to use as an initial tablet boundary.
229 },
230 ],
231 "tableId": "A String", # The name by which the new table should be referred to within the parent
232 # instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
233 }
234
235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240Returns:
241 An object of the form:
242
243 { # A collection of user data indexed by row, column, and timestamp.
244 # Each table is served using the resources of its parent cluster.
245 "clusterStates": { # Output only.
246 # Map from cluster ID to per-cluster table state.
247 # If it could not be determined whether or not the table has data in a
248 # particular cluster (for example, if its zone is unavailable), then
249 # there will be an entry for the cluster with UNKNOWN `replication_status`.
250 # Views: `REPLICATION_VIEW`, `FULL`
251 "a_key": { # The state of a table's data in a particular cluster.
252 "replicationState": "A String", # Output only.
253 # The state of replication for the table in this cluster.
254 },
255 },
256 "columnFamilies": { # (`CreationOnly`)
257 # The column families configured for this table, mapped by column family ID.
258 # Views: `SCHEMA_VIEW`, `FULL`
259 "a_key": { # A set of columns within a table which share a common configuration.
260 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
261 # Must serialize to at most 500 bytes.
262 #
263 # NOTE: Garbage collection executes opportunistically in the background, and
264 # so it's possible for reads to return a cell even if it matches the active
265 # GC expression for its family.
266 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
267 "rules": [ # Delete cells which would be deleted by any element of `rules`.
268 # Object with schema name: GcRule
269 ],
270 },
271 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
272 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
273 # Object with schema name: GcRule
274 ],
275 },
276 "maxAge": "A String", # Delete cells in a column older than the given age.
277 # Values must be at least one millisecond, and will be truncated to
278 # microsecond granularity.
279 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
280 },
281 },
282 },
283 "name": "A String", # Output only.
284 # The unique name of the table. Values are of the form
285 # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
286 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
287 "granularity": "A String", # (`CreationOnly`)
288 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
289 # this table. Timestamps not matching the granularity will be rejected.
290 # If unspecified at creation time, the value will be set to `MILLIS`.
291 # Views: `SCHEMA_VIEW`, `FULL`.
292 }</pre>
293</div>
294
295<div class="method">
296 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
297 <pre>Permanently deletes a specified table and all of its data.
298
299Args:
300 name: string, The unique name of the table to be deleted.
301Values are of the form
302`projects/<project>/instances/<instance>/tables/<table>`. (required)
303 x__xgafv: string, V1 error format.
304 Allowed values
305 1 - v1 error format
306 2 - v2 error format
307
308Returns:
309 An object of the form:
310
311 { # A generic empty message that you can re-use to avoid defining duplicated
312 # empty messages in your APIs. A typical example is to use it as the request
313 # or the response type of an API method. For instance:
314 #
315 # service Foo {
316 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
317 # }
318 #
319 # The JSON representation for `Empty` is empty JSON object `{}`.
320 }</pre>
321</div>
322
323<div class="method">
324 <code class="details" id="dropRowRange">dropRowRange(name, body, x__xgafv=None)</code>
325 <pre>Permanently drop/delete a row range from a specified table. The request can
326specify whether to delete all rows in a table, or only those that match a
327particular prefix.
328
329Args:
330 name: string, The unique name of the table on which to drop a range of rows.
331Values are of the form
332`projects/<project>/instances/<instance>/tables/<table>`. (required)
333 body: object, The request body. (required)
334 The object takes the form of:
335
336{ # Request message for
337 # google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
338 "rowKeyPrefix": "A String", # Delete all rows that start with this row key prefix. Prefix cannot be
339 # zero length.
340 "deleteAllDataFromTable": True or False, # Delete all rows in the table. Setting this to false is a no-op.
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
351 { # A generic empty message that you can re-use to avoid defining duplicated
352 # empty messages in your APIs. A typical example is to use it as the request
353 # or the response type of an API method. For instance:
354 #
355 # service Foo {
356 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
357 # }
358 #
359 # The JSON representation for `Empty` is empty JSON object `{}`.
360 }</pre>
361</div>
362
363<div class="method">
364 <code class="details" id="generateConsistencyToken">generateConsistencyToken(name, body=None, x__xgafv=None)</code>
365 <pre>Generates a consistency token for a Table, which can be used in
366CheckConsistency to check whether mutations to the table that finished
367before this call started have been replicated. The tokens will be available
368for 90 days.
369
370Args:
371 name: string, The unique name of the Table for which to create a consistency token.
372Values are of the form
373`projects/<project>/instances/<instance>/tables/<table>`. (required)
374 body: object, The request body.
375 The object takes the form of:
376
377{ # Request message for
378 # google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
379 }
380
381 x__xgafv: string, V1 error format.
382 Allowed values
383 1 - v1 error format
384 2 - v2 error format
385
386Returns:
387 An object of the form:
388
389 { # Response message for
390 # google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
391 "consistencyToken": "A String", # The generated consistency token.
392 }</pre>
393</div>
394
395<div class="method">
396 <code class="details" id="get">get(name, x__xgafv=None, view=None)</code>
397 <pre>Gets metadata information about the specified table.
398
399Args:
400 name: string, The unique name of the requested table.
401Values are of the form
402`projects/<project>/instances/<instance>/tables/<table>`. (required)
403 x__xgafv: string, V1 error format.
404 Allowed values
405 1 - v1 error format
406 2 - v2 error format
407 view: string, The view to be applied to the returned table's fields.
408Defaults to `SCHEMA_VIEW` if unspecified.
409
410Returns:
411 An object of the form:
412
413 { # A collection of user data indexed by row, column, and timestamp.
414 # Each table is served using the resources of its parent cluster.
415 "clusterStates": { # Output only.
416 # Map from cluster ID to per-cluster table state.
417 # If it could not be determined whether or not the table has data in a
418 # particular cluster (for example, if its zone is unavailable), then
419 # there will be an entry for the cluster with UNKNOWN `replication_status`.
420 # Views: `REPLICATION_VIEW`, `FULL`
421 "a_key": { # The state of a table's data in a particular cluster.
422 "replicationState": "A String", # Output only.
423 # The state of replication for the table in this cluster.
424 },
425 },
426 "columnFamilies": { # (`CreationOnly`)
427 # The column families configured for this table, mapped by column family ID.
428 # Views: `SCHEMA_VIEW`, `FULL`
429 "a_key": { # A set of columns within a table which share a common configuration.
430 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
431 # Must serialize to at most 500 bytes.
432 #
433 # NOTE: Garbage collection executes opportunistically in the background, and
434 # so it's possible for reads to return a cell even if it matches the active
435 # GC expression for its family.
436 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
437 "rules": [ # Delete cells which would be deleted by any element of `rules`.
438 # Object with schema name: GcRule
439 ],
440 },
441 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
442 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
443 # Object with schema name: GcRule
444 ],
445 },
446 "maxAge": "A String", # Delete cells in a column older than the given age.
447 # Values must be at least one millisecond, and will be truncated to
448 # microsecond granularity.
449 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
450 },
451 },
452 },
453 "name": "A String", # Output only.
454 # The unique name of the table. Values are of the form
455 # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
456 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
457 "granularity": "A String", # (`CreationOnly`)
458 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
459 # this table. Timestamps not matching the granularity will be rejected.
460 # If unspecified at creation time, the value will be set to `MILLIS`.
461 # Views: `SCHEMA_VIEW`, `FULL`.
462 }</pre>
463</div>
464
465<div class="method">
466 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
467 <pre>Gets the access control policy for an instance resource. Returns an empty
468policy if an table exists but does not have a policy set.
469
470Args:
471 resource: string, REQUIRED: The resource for which the policy is being requested.
472See the operation documentation for the appropriate value for this field. (required)
473 body: object, The request body.
474 The object takes the form of:
475
476{ # Request message for `GetIamPolicy` method.
477 }
478
479 x__xgafv: string, V1 error format.
480 Allowed values
481 1 - v1 error format
482 2 - v2 error format
483
484Returns:
485 An object of the form:
486
487 { # Defines an Identity and Access Management (IAM) policy. It is used to
488 # specify access control policies for Cloud Platform resources.
489 #
490 #
491 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
492 # `members` to a `role`, where the members can be user accounts, Google groups,
493 # Google domains, and service accounts. A `role` is a named list of permissions
494 # defined by IAM.
495 #
496 # **JSON Example**
497 #
498 # {
499 # "bindings": [
500 # {
501 # "role": "roles/owner",
502 # "members": [
503 # "user:mike@example.com",
504 # "group:admins@example.com",
505 # "domain:google.com",
506 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
507 # ]
508 # },
509 # {
510 # "role": "roles/viewer",
511 # "members": ["user:sean@example.com"]
512 # }
513 # ]
514 # }
515 #
516 # **YAML Example**
517 #
518 # bindings:
519 # - members:
520 # - user:mike@example.com
521 # - group:admins@example.com
522 # - domain:google.com
523 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
524 # role: roles/owner
525 # - members:
526 # - user:sean@example.com
527 # role: roles/viewer
528 #
529 #
530 # For a description of IAM and its features, see the
531 # [IAM developer's guide](https://cloud.google.com/iam/docs).
532 "bindings": [ # Associates a list of `members` to a `role`.
533 # `bindings` with no members will result in an error.
534 { # Associates `members` with a `role`.
535 "role": "A String", # Role that is assigned to `members`.
536 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
537 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
538 # NOTE: An unsatisfied condition will not allow user access via current
539 # binding. Different bindings, including their conditions, are examined
540 # independently.
541 #
542 # title: "User account presence"
543 # description: "Determines whether the request has a user account"
544 # expression: "size(request.user) > 0"
545 "description": "A String", # An optional description of the expression. This is a longer text which
546 # describes the expression, e.g. when hovered over it in a UI.
547 "expression": "A String", # Textual representation of an expression in
548 # Common Expression Language syntax.
549 #
550 # The application context of the containing message determines which
551 # well-known feature set of CEL is supported.
552 "location": "A String", # An optional string indicating the location of the expression for error
553 # reporting, e.g. a file name and a position in the file.
554 "title": "A String", # An optional title for the expression, i.e. a short string describing
555 # its purpose. This can be used e.g. in UIs which allow to enter the
556 # expression.
557 },
558 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
559 # `members` can have the following values:
560 #
561 # * `allUsers`: A special identifier that represents anyone who is
562 # on the internet; with or without a Google account.
563 #
564 # * `allAuthenticatedUsers`: A special identifier that represents anyone
565 # who is authenticated with a Google account or a service account.
566 #
567 # * `user:{emailid}`: An email address that represents a specific Google
568 # account. For example, `alice@gmail.com` .
569 #
570 #
571 # * `serviceAccount:{emailid}`: An email address that represents a service
572 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
573 #
574 # * `group:{emailid}`: An email address that represents a Google group.
575 # For example, `admins@example.com`.
576 #
577 #
578 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
579 # users of that domain. For example, `google.com` or `example.com`.
580 #
581 "A String",
582 ],
583 },
584 ],
585 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
586 { # Specifies the audit configuration for a service.
587 # The configuration determines which permission types are logged, and what
588 # identities, if any, are exempted from logging.
589 # An AuditConfig must have one or more AuditLogConfigs.
590 #
591 # If there are AuditConfigs for both `allServices` and a specific service,
592 # the union of the two AuditConfigs is used for that service: the log_types
593 # specified in each AuditConfig are enabled, and the exempted_members in each
594 # AuditLogConfig are exempted.
595 #
596 # Example Policy with multiple AuditConfigs:
597 #
598 # {
599 # "audit_configs": [
600 # {
601 # "service": "allServices"
602 # "audit_log_configs": [
603 # {
604 # "log_type": "DATA_READ",
605 # "exempted_members": [
606 # "user:foo@gmail.com"
607 # ]
608 # },
609 # {
610 # "log_type": "DATA_WRITE",
611 # },
612 # {
613 # "log_type": "ADMIN_READ",
614 # }
615 # ]
616 # },
617 # {
618 # "service": "fooservice.googleapis.com"
619 # "audit_log_configs": [
620 # {
621 # "log_type": "DATA_READ",
622 # },
623 # {
624 # "log_type": "DATA_WRITE",
625 # "exempted_members": [
626 # "user:bar@gmail.com"
627 # ]
628 # }
629 # ]
630 # }
631 # ]
632 # }
633 #
634 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
635 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
636 # bar@gmail.com from DATA_WRITE logging.
637 "auditLogConfigs": [ # The configuration for logging of each type of permission.
638 { # Provides the configuration for logging a type of permissions.
639 # Example:
640 #
641 # {
642 # "audit_log_configs": [
643 # {
644 # "log_type": "DATA_READ",
645 # "exempted_members": [
646 # "user:foo@gmail.com"
647 # ]
648 # },
649 # {
650 # "log_type": "DATA_WRITE",
651 # }
652 # ]
653 # }
654 #
655 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
656 # foo@gmail.com from DATA_READ logging.
657 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
658 # permission.
659 # Follows the same format of Binding.members.
660 "A String",
661 ],
662 "logType": "A String", # The log type that this config enables.
663 },
664 ],
665 "service": "A String", # Specifies a service that will be enabled for audit logging.
666 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
667 # `allServices` is a special value that covers all services.
668 },
669 ],
670 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
671 # prevent simultaneous updates of a policy from overwriting each other.
672 # It is strongly suggested that systems make use of the `etag` in the
673 # read-modify-write cycle to perform policy updates in order to avoid race
674 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
675 # systems are expected to put that etag in the request to `setIamPolicy` to
676 # ensure that their change will be applied to the same version of the policy.
677 #
678 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
679 # policy is overwritten blindly.
680 "version": 42, # Deprecated.
681 }</pre>
682</div>
683
684<div class="method">
685 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</code>
686 <pre>Lists all tables served from a specified instance.
687
688Args:
689 parent: string, The unique name of the instance for which tables should be listed.
690Values are of the form `projects/<project>/instances/<instance>`. (required)
691 pageToken: string, The value of `next_page_token` returned by a previous call.
692 x__xgafv: string, V1 error format.
693 Allowed values
694 1 - v1 error format
695 2 - v2 error format
696 pageSize: integer, Maximum number of results per page.
697
698A page_size of zero lets the server choose the number of items to return.
699A page_size which is strictly positive will return at most that many items.
700A negative page_size will cause an error.
701
702Following the first request, subsequent paginated calls are not required
703to pass a page_size. If a page_size is set in subsequent calls, it must
704match the page_size given in the first request.
705 view: string, The view to be applied to the returned tables' fields.
706Defaults to `NAME_ONLY` if unspecified; no others are currently supported.
707
708Returns:
709 An object of the form:
710
711 { # Response message for
712 # google.bigtable.admin.v2.BigtableTableAdmin.ListTables
713 "nextPageToken": "A String", # Set if not all tables could be returned in a single response.
714 # Pass this value to `page_token` in another request to get the next
715 # page of results.
716 "tables": [ # The tables present in the requested instance.
717 { # A collection of user data indexed by row, column, and timestamp.
718 # Each table is served using the resources of its parent cluster.
719 "clusterStates": { # Output only.
720 # Map from cluster ID to per-cluster table state.
721 # If it could not be determined whether or not the table has data in a
722 # particular cluster (for example, if its zone is unavailable), then
723 # there will be an entry for the cluster with UNKNOWN `replication_status`.
724 # Views: `REPLICATION_VIEW`, `FULL`
725 "a_key": { # The state of a table's data in a particular cluster.
726 "replicationState": "A String", # Output only.
727 # The state of replication for the table in this cluster.
728 },
729 },
730 "columnFamilies": { # (`CreationOnly`)
731 # The column families configured for this table, mapped by column family ID.
732 # Views: `SCHEMA_VIEW`, `FULL`
733 "a_key": { # A set of columns within a table which share a common configuration.
734 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
735 # Must serialize to at most 500 bytes.
736 #
737 # NOTE: Garbage collection executes opportunistically in the background, and
738 # so it's possible for reads to return a cell even if it matches the active
739 # GC expression for its family.
740 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
741 "rules": [ # Delete cells which would be deleted by any element of `rules`.
742 # Object with schema name: GcRule
743 ],
744 },
745 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
746 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
747 # Object with schema name: GcRule
748 ],
749 },
750 "maxAge": "A String", # Delete cells in a column older than the given age.
751 # Values must be at least one millisecond, and will be truncated to
752 # microsecond granularity.
753 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
754 },
755 },
756 },
757 "name": "A String", # Output only.
758 # The unique name of the table. Values are of the form
759 # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
760 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
761 "granularity": "A String", # (`CreationOnly`)
762 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
763 # this table. Timestamps not matching the granularity will be rejected.
764 # If unspecified at creation time, the value will be set to `MILLIS`.
765 # Views: `SCHEMA_VIEW`, `FULL`.
766 },
767 ],
768 }</pre>
769</div>
770
771<div class="method">
772 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
773 <pre>Retrieves the next page of results.
774
775Args:
776 previous_request: The request for the previous page. (required)
777 previous_response: The response from the request for the previous page. (required)
778
779Returns:
780 A request object that you can call 'execute()' on to request the next
781 page. Returns None if there are no more items in the collection.
782 </pre>
783</div>
784
785<div class="method">
786 <code class="details" id="modifyColumnFamilies">modifyColumnFamilies(name, body, x__xgafv=None)</code>
787 <pre>Performs a series of column family modifications on the specified table.
788Either all or none of the modifications will occur before this method
789returns, but data requests received prior to that point may see a table
790where only some modifications have taken effect.
791
792Args:
793 name: string, The unique name of the table whose families should be modified.
794Values are of the form
795`projects/<project>/instances/<instance>/tables/<table>`. (required)
796 body: object, The request body. (required)
797 The object takes the form of:
798
799{ # Request message for
800 # google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
801 "modifications": [ # Modifications to be atomically applied to the specified table's families.
802 # Entries are applied in order, meaning that earlier modifications can be
803 # masked by later ones (in the case of repeated updates to the same family,
804 # for example).
805 { # A create, update, or delete of a particular column family.
806 "create": { # A set of columns within a table which share a common configuration. # Create a new column family with the specified schema, or fail if
807 # one already exists with the given ID.
808 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
809 # Must serialize to at most 500 bytes.
810 #
811 # NOTE: Garbage collection executes opportunistically in the background, and
812 # so it's possible for reads to return a cell even if it matches the active
813 # GC expression for its family.
814 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
815 "rules": [ # Delete cells which would be deleted by any element of `rules`.
816 # Object with schema name: GcRule
817 ],
818 },
819 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
820 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
821 # Object with schema name: GcRule
822 ],
823 },
824 "maxAge": "A String", # Delete cells in a column older than the given age.
825 # Values must be at least one millisecond, and will be truncated to
826 # microsecond granularity.
827 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
828 },
829 },
830 "drop": True or False, # Drop (delete) the column family with the given ID, or fail if no such
831 # family exists.
832 "update": { # A set of columns within a table which share a common configuration. # Update an existing column family to the specified schema, or fail
833 # if no column family exists with the given ID.
834 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
835 # Must serialize to at most 500 bytes.
836 #
837 # NOTE: Garbage collection executes opportunistically in the background, and
838 # so it's possible for reads to return a cell even if it matches the active
839 # GC expression for its family.
840 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
841 "rules": [ # Delete cells which would be deleted by any element of `rules`.
842 # Object with schema name: GcRule
843 ],
844 },
845 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
846 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
847 # Object with schema name: GcRule
848 ],
849 },
850 "maxAge": "A String", # Delete cells in a column older than the given age.
851 # Values must be at least one millisecond, and will be truncated to
852 # microsecond granularity.
853 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
854 },
855 },
856 "id": "A String", # The ID of the column family to be modified.
857 },
858 ],
859 }
860
861 x__xgafv: string, V1 error format.
862 Allowed values
863 1 - v1 error format
864 2 - v2 error format
865
866Returns:
867 An object of the form:
868
869 { # A collection of user data indexed by row, column, and timestamp.
870 # Each table is served using the resources of its parent cluster.
871 "clusterStates": { # Output only.
872 # Map from cluster ID to per-cluster table state.
873 # If it could not be determined whether or not the table has data in a
874 # particular cluster (for example, if its zone is unavailable), then
875 # there will be an entry for the cluster with UNKNOWN `replication_status`.
876 # Views: `REPLICATION_VIEW`, `FULL`
877 "a_key": { # The state of a table's data in a particular cluster.
878 "replicationState": "A String", # Output only.
879 # The state of replication for the table in this cluster.
880 },
881 },
882 "columnFamilies": { # (`CreationOnly`)
883 # The column families configured for this table, mapped by column family ID.
884 # Views: `SCHEMA_VIEW`, `FULL`
885 "a_key": { # A set of columns within a table which share a common configuration.
886 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
887 # Must serialize to at most 500 bytes.
888 #
889 # NOTE: Garbage collection executes opportunistically in the background, and
890 # so it's possible for reads to return a cell even if it matches the active
891 # GC expression for its family.
892 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
893 "rules": [ # Delete cells which would be deleted by any element of `rules`.
894 # Object with schema name: GcRule
895 ],
896 },
897 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
898 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
899 # Object with schema name: GcRule
900 ],
901 },
902 "maxAge": "A String", # Delete cells in a column older than the given age.
903 # Values must be at least one millisecond, and will be truncated to
904 # microsecond granularity.
905 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
906 },
907 },
908 },
909 "name": "A String", # Output only.
910 # The unique name of the table. Values are of the form
911 # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
912 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
913 "granularity": "A String", # (`CreationOnly`)
914 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
915 # this table. Timestamps not matching the granularity will be rejected.
916 # If unspecified at creation time, the value will be set to `MILLIS`.
917 # Views: `SCHEMA_VIEW`, `FULL`.
918 }</pre>
919</div>
920
921<div class="method">
922 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
923 <pre>Sets the access control policy on a table resource. Replaces any existing
924policy.
925
926Args:
927 resource: string, REQUIRED: The resource for which the policy is being specified.
928See the operation documentation for the appropriate value for this field. (required)
929 body: object, The request body. (required)
930 The object takes the form of:
931
932{ # Request message for `SetIamPolicy` method.
933 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
934 # the policy is limited to a few 10s of KB. An empty policy is a
935 # valid policy but certain Cloud Platform services (such as Projects)
936 # might reject them.
937 # specify access control policies for Cloud Platform resources.
938 #
939 #
940 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
941 # `members` to a `role`, where the members can be user accounts, Google groups,
942 # Google domains, and service accounts. A `role` is a named list of permissions
943 # defined by IAM.
944 #
945 # **JSON Example**
946 #
947 # {
948 # "bindings": [
949 # {
950 # "role": "roles/owner",
951 # "members": [
952 # "user:mike@example.com",
953 # "group:admins@example.com",
954 # "domain:google.com",
955 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
956 # ]
957 # },
958 # {
959 # "role": "roles/viewer",
960 # "members": ["user:sean@example.com"]
961 # }
962 # ]
963 # }
964 #
965 # **YAML Example**
966 #
967 # bindings:
968 # - members:
969 # - user:mike@example.com
970 # - group:admins@example.com
971 # - domain:google.com
972 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
973 # role: roles/owner
974 # - members:
975 # - user:sean@example.com
976 # role: roles/viewer
977 #
978 #
979 # For a description of IAM and its features, see the
980 # [IAM developer's guide](https://cloud.google.com/iam/docs).
981 "bindings": [ # Associates a list of `members` to a `role`.
982 # `bindings` with no members will result in an error.
983 { # Associates `members` with a `role`.
984 "role": "A String", # Role that is assigned to `members`.
985 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
986 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
987 # NOTE: An unsatisfied condition will not allow user access via current
988 # binding. Different bindings, including their conditions, are examined
989 # independently.
990 #
991 # title: "User account presence"
992 # description: "Determines whether the request has a user account"
993 # expression: "size(request.user) > 0"
994 "description": "A String", # An optional description of the expression. This is a longer text which
995 # describes the expression, e.g. when hovered over it in a UI.
996 "expression": "A String", # Textual representation of an expression in
997 # Common Expression Language syntax.
998 #
999 # The application context of the containing message determines which
1000 # well-known feature set of CEL is supported.
1001 "location": "A String", # An optional string indicating the location of the expression for error
1002 # reporting, e.g. a file name and a position in the file.
1003 "title": "A String", # An optional title for the expression, i.e. a short string describing
1004 # its purpose. This can be used e.g. in UIs which allow to enter the
1005 # expression.
1006 },
1007 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1008 # `members` can have the following values:
1009 #
1010 # * `allUsers`: A special identifier that represents anyone who is
1011 # on the internet; with or without a Google account.
1012 #
1013 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1014 # who is authenticated with a Google account or a service account.
1015 #
1016 # * `user:{emailid}`: An email address that represents a specific Google
1017 # account. For example, `alice@gmail.com` .
1018 #
1019 #
1020 # * `serviceAccount:{emailid}`: An email address that represents a service
1021 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1022 #
1023 # * `group:{emailid}`: An email address that represents a Google group.
1024 # For example, `admins@example.com`.
1025 #
1026 #
1027 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1028 # users of that domain. For example, `google.com` or `example.com`.
1029 #
1030 "A String",
1031 ],
1032 },
1033 ],
1034 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1035 { # Specifies the audit configuration for a service.
1036 # The configuration determines which permission types are logged, and what
1037 # identities, if any, are exempted from logging.
1038 # An AuditConfig must have one or more AuditLogConfigs.
1039 #
1040 # If there are AuditConfigs for both `allServices` and a specific service,
1041 # the union of the two AuditConfigs is used for that service: the log_types
1042 # specified in each AuditConfig are enabled, and the exempted_members in each
1043 # AuditLogConfig are exempted.
1044 #
1045 # Example Policy with multiple AuditConfigs:
1046 #
1047 # {
1048 # "audit_configs": [
1049 # {
1050 # "service": "allServices"
1051 # "audit_log_configs": [
1052 # {
1053 # "log_type": "DATA_READ",
1054 # "exempted_members": [
1055 # "user:foo@gmail.com"
1056 # ]
1057 # },
1058 # {
1059 # "log_type": "DATA_WRITE",
1060 # },
1061 # {
1062 # "log_type": "ADMIN_READ",
1063 # }
1064 # ]
1065 # },
1066 # {
1067 # "service": "fooservice.googleapis.com"
1068 # "audit_log_configs": [
1069 # {
1070 # "log_type": "DATA_READ",
1071 # },
1072 # {
1073 # "log_type": "DATA_WRITE",
1074 # "exempted_members": [
1075 # "user:bar@gmail.com"
1076 # ]
1077 # }
1078 # ]
1079 # }
1080 # ]
1081 # }
1082 #
1083 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1084 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
1085 # bar@gmail.com from DATA_WRITE logging.
1086 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1087 { # Provides the configuration for logging a type of permissions.
1088 # Example:
1089 #
1090 # {
1091 # "audit_log_configs": [
1092 # {
1093 # "log_type": "DATA_READ",
1094 # "exempted_members": [
1095 # "user:foo@gmail.com"
1096 # ]
1097 # },
1098 # {
1099 # "log_type": "DATA_WRITE",
1100 # }
1101 # ]
1102 # }
1103 #
1104 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
1105 # foo@gmail.com from DATA_READ logging.
1106 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1107 # permission.
1108 # Follows the same format of Binding.members.
1109 "A String",
1110 ],
1111 "logType": "A String", # The log type that this config enables.
1112 },
1113 ],
1114 "service": "A String", # Specifies a service that will be enabled for audit logging.
1115 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1116 # `allServices` is a special value that covers all services.
1117 },
1118 ],
1119 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1120 # prevent simultaneous updates of a policy from overwriting each other.
1121 # It is strongly suggested that systems make use of the `etag` in the
1122 # read-modify-write cycle to perform policy updates in order to avoid race
1123 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1124 # systems are expected to put that etag in the request to `setIamPolicy` to
1125 # ensure that their change will be applied to the same version of the policy.
1126 #
1127 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
1128 # policy is overwritten blindly.
1129 "version": 42, # Deprecated.
1130 },
1131 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
1132 # the fields in the mask will be modified. If no mask is provided, the
1133 # following default mask is used:
1134 # paths: "bindings, etag"
1135 # This field is only used by Cloud IAM.
1136 }
1137
1138 x__xgafv: string, V1 error format.
1139 Allowed values
1140 1 - v1 error format
1141 2 - v2 error format
1142
1143Returns:
1144 An object of the form:
1145
1146 { # Defines an Identity and Access Management (IAM) policy. It is used to
1147 # specify access control policies for Cloud Platform resources.
1148 #
1149 #
1150 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
1151 # `members` to a `role`, where the members can be user accounts, Google groups,
1152 # Google domains, and service accounts. A `role` is a named list of permissions
1153 # defined by IAM.
1154 #
1155 # **JSON Example**
1156 #
1157 # {
1158 # "bindings": [
1159 # {
1160 # "role": "roles/owner",
1161 # "members": [
1162 # "user:mike@example.com",
1163 # "group:admins@example.com",
1164 # "domain:google.com",
1165 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
1166 # ]
1167 # },
1168 # {
1169 # "role": "roles/viewer",
1170 # "members": ["user:sean@example.com"]
1171 # }
1172 # ]
1173 # }
1174 #
1175 # **YAML Example**
1176 #
1177 # bindings:
1178 # - members:
1179 # - user:mike@example.com
1180 # - group:admins@example.com
1181 # - domain:google.com
1182 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
1183 # role: roles/owner
1184 # - members:
1185 # - user:sean@example.com
1186 # role: roles/viewer
1187 #
1188 #
1189 # For a description of IAM and its features, see the
1190 # [IAM developer's guide](https://cloud.google.com/iam/docs).
1191 "bindings": [ # Associates a list of `members` to a `role`.
1192 # `bindings` with no members will result in an error.
1193 { # Associates `members` with a `role`.
1194 "role": "A String", # Role that is assigned to `members`.
1195 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1196 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
1197 # NOTE: An unsatisfied condition will not allow user access via current
1198 # binding. Different bindings, including their conditions, are examined
1199 # independently.
1200 #
1201 # title: "User account presence"
1202 # description: "Determines whether the request has a user account"
1203 # expression: "size(request.user) > 0"
1204 "description": "A String", # An optional description of the expression. This is a longer text which
1205 # describes the expression, e.g. when hovered over it in a UI.
1206 "expression": "A String", # Textual representation of an expression in
1207 # Common Expression Language syntax.
1208 #
1209 # The application context of the containing message determines which
1210 # well-known feature set of CEL is supported.
1211 "location": "A String", # An optional string indicating the location of the expression for error
1212 # reporting, e.g. a file name and a position in the file.
1213 "title": "A String", # An optional title for the expression, i.e. a short string describing
1214 # its purpose. This can be used e.g. in UIs which allow to enter the
1215 # expression.
1216 },
1217 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1218 # `members` can have the following values:
1219 #
1220 # * `allUsers`: A special identifier that represents anyone who is
1221 # on the internet; with or without a Google account.
1222 #
1223 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1224 # who is authenticated with a Google account or a service account.
1225 #
1226 # * `user:{emailid}`: An email address that represents a specific Google
1227 # account. For example, `alice@gmail.com` .
1228 #
1229 #
1230 # * `serviceAccount:{emailid}`: An email address that represents a service
1231 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1232 #
1233 # * `group:{emailid}`: An email address that represents a Google group.
1234 # For example, `admins@example.com`.
1235 #
1236 #
1237 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1238 # users of that domain. For example, `google.com` or `example.com`.
1239 #
1240 "A String",
1241 ],
1242 },
1243 ],
1244 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1245 { # Specifies the audit configuration for a service.
1246 # The configuration determines which permission types are logged, and what
1247 # identities, if any, are exempted from logging.
1248 # An AuditConfig must have one or more AuditLogConfigs.
1249 #
1250 # If there are AuditConfigs for both `allServices` and a specific service,
1251 # the union of the two AuditConfigs is used for that service: the log_types
1252 # specified in each AuditConfig are enabled, and the exempted_members in each
1253 # AuditLogConfig are exempted.
1254 #
1255 # Example Policy with multiple AuditConfigs:
1256 #
1257 # {
1258 # "audit_configs": [
1259 # {
1260 # "service": "allServices"
1261 # "audit_log_configs": [
1262 # {
1263 # "log_type": "DATA_READ",
1264 # "exempted_members": [
1265 # "user:foo@gmail.com"
1266 # ]
1267 # },
1268 # {
1269 # "log_type": "DATA_WRITE",
1270 # },
1271 # {
1272 # "log_type": "ADMIN_READ",
1273 # }
1274 # ]
1275 # },
1276 # {
1277 # "service": "fooservice.googleapis.com"
1278 # "audit_log_configs": [
1279 # {
1280 # "log_type": "DATA_READ",
1281 # },
1282 # {
1283 # "log_type": "DATA_WRITE",
1284 # "exempted_members": [
1285 # "user:bar@gmail.com"
1286 # ]
1287 # }
1288 # ]
1289 # }
1290 # ]
1291 # }
1292 #
1293 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1294 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
1295 # bar@gmail.com from DATA_WRITE logging.
1296 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1297 { # Provides the configuration for logging a type of permissions.
1298 # Example:
1299 #
1300 # {
1301 # "audit_log_configs": [
1302 # {
1303 # "log_type": "DATA_READ",
1304 # "exempted_members": [
1305 # "user:foo@gmail.com"
1306 # ]
1307 # },
1308 # {
1309 # "log_type": "DATA_WRITE",
1310 # }
1311 # ]
1312 # }
1313 #
1314 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
1315 # foo@gmail.com from DATA_READ logging.
1316 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1317 # permission.
1318 # Follows the same format of Binding.members.
1319 "A String",
1320 ],
1321 "logType": "A String", # The log type that this config enables.
1322 },
1323 ],
1324 "service": "A String", # Specifies a service that will be enabled for audit logging.
1325 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1326 # `allServices` is a special value that covers all services.
1327 },
1328 ],
1329 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1330 # prevent simultaneous updates of a policy from overwriting each other.
1331 # It is strongly suggested that systems make use of the `etag` in the
1332 # read-modify-write cycle to perform policy updates in order to avoid race
1333 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1334 # systems are expected to put that etag in the request to `setIamPolicy` to
1335 # ensure that their change will be applied to the same version of the policy.
1336 #
1337 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
1338 # policy is overwritten blindly.
1339 "version": 42, # Deprecated.
1340 }</pre>
1341</div>
1342
1343<div class="method">
1344 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
1345 <pre>Returns permissions that the caller has on the specified table resource.
1346
1347Args:
1348 resource: string, REQUIRED: The resource for which the policy detail is being requested.
1349See the operation documentation for the appropriate value for this field. (required)
1350 body: object, The request body. (required)
1351 The object takes the form of:
1352
1353{ # Request message for `TestIamPermissions` method.
1354 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1355 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1356 # information see
1357 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1358 "A String",
1359 ],
1360 }
1361
1362 x__xgafv: string, V1 error format.
1363 Allowed values
1364 1 - v1 error format
1365 2 - v2 error format
1366
1367Returns:
1368 An object of the form:
1369
1370 { # Response message for `TestIamPermissions` method.
1371 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1372 # allowed.
1373 "A String",
1374 ],
1375 }</pre>
1376</div>
1377
1378</body></html>