Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / bigtableadmin_v2.projects.instances.tables.html
blob: 3d25c3a6491e4ab3f463a9691754efaf529edc8e [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#checkConsistency">checkConsistency(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Checks replication consistency based on a consistency token, that is, if</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <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]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#dropRowRange">dropRowRange(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97<p class="firstline">Gets the access control policy for a Table or Backup resource.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 <code><a href="#modifyColumnFamilies">modifyColumnFamilies(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="firstline">Performs a series of column family modifications on the specified table.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
109<p class="firstline">Sets the access control policy on a Table or Backup resource.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 <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]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 <code class="details" id="checkConsistency">checkConsistency(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121 name: string, Required. The unique name of the Table for which to check replication consistency.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123`projects/{project}/instances/{instance}/tables/{table}`. (required)
124 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 The object takes the form of:
126
127{ # Request message for
128 # google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]129 "consistencyToken": "A String", # Required. The token created using GenerateConsistencyToken for the Table.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]154 parent: string, Required. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 The object takes the form of:
158
159{ # Request message for
160 # google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]161 "table": { # A collection of user data indexed by row, column, and timestamp. # Required. The Table to create.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 # Each table is served using the resources of its parent cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]163 "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 # If it could not be determined whether or not the table has data in a
165 # particular cluster (for example, if its zone is unavailable), then
166 # there will be an entry for the cluster with UNKNOWN `replication_status`.
167 # Views: `REPLICATION_VIEW`, `FULL`
168 "a_key": { # The state of a table's data in a particular cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]169 "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 },
171 },
172 "columnFamilies": { # (`CreationOnly`)
173 # The column families configured for this table, mapped by column family ID.
174 # Views: `SCHEMA_VIEW`, `FULL`
175 "a_key": { # A set of columns within a table which share a common configuration.
176 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
177 # Must serialize to at most 500 bytes.
178 #
179 # NOTE: Garbage collection executes opportunistically in the background, and
180 # so it's possible for reads to return a cell even if it matches the active
181 # GC expression for its family.
182 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
183 "rules": [ # Delete cells which would be deleted by any element of `rules`.
184 # Object with schema name: GcRule
185 ],
186 },
187 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
188 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
189 # Object with schema name: GcRule
190 ],
191 },
192 "maxAge": "A String", # Delete cells in a column older than the given age.
193 # Values must be at least one millisecond, and will be truncated to
194 # microsecond granularity.
195 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
196 },
197 },
198 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]199 "name": "A String", # Output only. The unique name of the table. Values are of the form
200 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/tables/_a-zA-Z0-9*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
202 "granularity": "A String", # (`CreationOnly`)
203 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
204 # this table. Timestamps not matching the granularity will be rejected.
205 # If unspecified at creation time, the value will be set to `MILLIS`.
206 # Views: `SCHEMA_VIEW`, `FULL`.
207 },
208 "initialSplits": [ # The optional list of row keys that will be used to initially split the
209 # table into several tablets (tablets are similar to HBase regions).
210 # Given two split keys, `s1` and `s2`, three tablets will be created,
211 # spanning the key ranges: `[, s1), [s1, s2), [s2, )`.
212 #
213 # Example:
214 #
215 # * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",`
216 # `"other", "zz"]`
217 # * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`
218 # * Key assignment:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]219 # - Tablet 1 `[, apple) =&gt; {"a"}.`
220 # - Tablet 2 `[apple, customer_1) =&gt; {"apple", "custom"}.`
221 # - Tablet 3 `[customer_1, customer_2) =&gt; {"customer_1"}.`
222 # - Tablet 4 `[customer_2, other) =&gt; {"customer_2"}.`
223 # - Tablet 5 `[other, ) =&gt; {"other", "zz"}.`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 { # An initial split point for a newly created table.
225 "key": "A String", # Row key to use as an initial tablet boundary.
226 },
227 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]228 "tableId": "A String", # Required. The name by which the new table should be referred to within the parent
229 # instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
230 # Maximum 50 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]231 }
232
233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
237
238Returns:
239 An object of the form:
240
241 { # A collection of user data indexed by row, column, and timestamp.
242 # Each table is served using the resources of its parent cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]243 "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 # If it could not be determined whether or not the table has data in a
245 # particular cluster (for example, if its zone is unavailable), then
246 # there will be an entry for the cluster with UNKNOWN `replication_status`.
247 # Views: `REPLICATION_VIEW`, `FULL`
248 "a_key": { # The state of a table's data in a particular cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]249 "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 },
251 },
252 "columnFamilies": { # (`CreationOnly`)
253 # The column families configured for this table, mapped by column family ID.
254 # Views: `SCHEMA_VIEW`, `FULL`
255 "a_key": { # A set of columns within a table which share a common configuration.
256 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
257 # Must serialize to at most 500 bytes.
258 #
259 # NOTE: Garbage collection executes opportunistically in the background, and
260 # so it's possible for reads to return a cell even if it matches the active
261 # GC expression for its family.
262 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
263 "rules": [ # Delete cells which would be deleted by any element of `rules`.
264 # Object with schema name: GcRule
265 ],
266 },
267 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
268 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
269 # Object with schema name: GcRule
270 ],
271 },
272 "maxAge": "A String", # Delete cells in a column older than the given age.
273 # Values must be at least one millisecond, and will be truncated to
274 # microsecond granularity.
275 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
276 },
277 },
278 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]279 "name": "A String", # Output only. The unique name of the table. Values are of the form
280 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/tables/_a-zA-Z0-9*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]281 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
282 "granularity": "A String", # (`CreationOnly`)
283 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
284 # this table. Timestamps not matching the granularity will be rejected.
285 # If unspecified at creation time, the value will be set to `MILLIS`.
286 # Views: `SCHEMA_VIEW`, `FULL`.
287 }</pre>
288</div>
289
290<div class="method">
291 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
292 <pre>Permanently deletes a specified table and all of its data.
293
294Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]295 name: string, Required. The unique name of the table to be deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]297`projects/{project}/instances/{instance}/tables/{table}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298 x__xgafv: string, V1 error format.
299 Allowed values
300 1 - v1 error format
301 2 - v2 error format
302
303Returns:
304 An object of the form:
305
306 { # A generic empty message that you can re-use to avoid defining duplicated
307 # empty messages in your APIs. A typical example is to use it as the request
308 # or the response type of an API method. For instance:
309 #
310 # service Foo {
311 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
312 # }
313 #
314 # The JSON representation for `Empty` is empty JSON object `{}`.
315 }</pre>
316</div>
317
318<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]319 <code class="details" id="dropRowRange">dropRowRange(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 <pre>Permanently drop/delete a row range from a specified table. The request can
321specify whether to delete all rows in a table, or only those that match a
322particular prefix.
323
324Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]325 name: string, Required. The unique name of the table on which to drop a range of rows.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]327`projects/{project}/instances/{instance}/tables/{table}`. (required)
328 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 The object takes the form of:
330
331{ # Request message for
332 # google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
333 "rowKeyPrefix": "A String", # Delete all rows that start with this row key prefix. Prefix cannot be
334 # zero length.
335 "deleteAllDataFromTable": True or False, # Delete all rows in the table. Setting this to false is a no-op.
336 }
337
338 x__xgafv: string, V1 error format.
339 Allowed values
340 1 - v1 error format
341 2 - v2 error format
342
343Returns:
344 An object of the form:
345
346 { # A generic empty message that you can re-use to avoid defining duplicated
347 # empty messages in your APIs. A typical example is to use it as the request
348 # or the response type of an API method. For instance:
349 #
350 # service Foo {
351 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
352 # }
353 #
354 # The JSON representation for `Empty` is empty JSON object `{}`.
355 }</pre>
356</div>
357
358<div class="method">
359 <code class="details" id="generateConsistencyToken">generateConsistencyToken(name, body=None, x__xgafv=None)</code>
360 <pre>Generates a consistency token for a Table, which can be used in
361CheckConsistency to check whether mutations to the table that finished
362before this call started have been replicated. The tokens will be available
363for 90 days.
364
365Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]366 name: string, Required. The unique name of the Table for which to create a consistency token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]367Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]368`projects/{project}/instances/{instance}/tables/{table}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 body: object, The request body.
370 The object takes the form of:
371
372{ # Request message for
373 # google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
374 }
375
376 x__xgafv: string, V1 error format.
377 Allowed values
378 1 - v1 error format
379 2 - v2 error format
380
381Returns:
382 An object of the form:
383
384 { # Response message for
385 # google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
386 "consistencyToken": "A String", # The generated consistency token.
387 }</pre>
388</div>
389
390<div class="method">
391 <code class="details" id="get">get(name, x__xgafv=None, view=None)</code>
392 <pre>Gets metadata information about the specified table.
393
394Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]395 name: string, Required. The unique name of the requested table.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]397`projects/{project}/instances/{instance}/tables/{table}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398 x__xgafv: string, V1 error format.
399 Allowed values
400 1 - v1 error format
401 2 - v2 error format
402 view: string, The view to be applied to the returned table's fields.
403Defaults to `SCHEMA_VIEW` if unspecified.
404
405Returns:
406 An object of the form:
407
408 { # A collection of user data indexed by row, column, and timestamp.
409 # Each table is served using the resources of its parent cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]410 "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]411 # If it could not be determined whether or not the table has data in a
412 # particular cluster (for example, if its zone is unavailable), then
413 # there will be an entry for the cluster with UNKNOWN `replication_status`.
414 # Views: `REPLICATION_VIEW`, `FULL`
415 "a_key": { # The state of a table's data in a particular cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]416 "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417 },
418 },
419 "columnFamilies": { # (`CreationOnly`)
420 # The column families configured for this table, mapped by column family ID.
421 # Views: `SCHEMA_VIEW`, `FULL`
422 "a_key": { # A set of columns within a table which share a common configuration.
423 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
424 # Must serialize to at most 500 bytes.
425 #
426 # NOTE: Garbage collection executes opportunistically in the background, and
427 # so it's possible for reads to return a cell even if it matches the active
428 # GC expression for its family.
429 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
430 "rules": [ # Delete cells which would be deleted by any element of `rules`.
431 # Object with schema name: GcRule
432 ],
433 },
434 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
435 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
436 # Object with schema name: GcRule
437 ],
438 },
439 "maxAge": "A String", # Delete cells in a column older than the given age.
440 # Values must be at least one millisecond, and will be truncated to
441 # microsecond granularity.
442 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
443 },
444 },
445 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]446 "name": "A String", # Output only. The unique name of the table. Values are of the form
447 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/tables/_a-zA-Z0-9*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]448 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
449 "granularity": "A String", # (`CreationOnly`)
450 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
451 # this table. Timestamps not matching the granularity will be rejected.
452 # If unspecified at creation time, the value will be set to `MILLIS`.
453 # Views: `SCHEMA_VIEW`, `FULL`.
454 }</pre>
455</div>
456
457<div class="method">
458 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]459 <pre>Gets the access control policy for a Table or Backup resource.
460Returns an empty policy if the resource exists but does not have a policy
461set.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]462
463Args:
464 resource: string, REQUIRED: The resource for which the policy is being requested.
465See the operation documentation for the appropriate value for this field. (required)
466 body: object, The request body.
467 The object takes the form of:
468
469{ # Request message for `GetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]470 "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
471 # `GetIamPolicy`. This field is only used by Cloud IAM.
472 "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
473 #
474 # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
475 # rejected.
476 #
477 # Requests for policies with any conditional bindings must specify version 3.
478 # Policies without any conditional bindings may specify any valid value or
479 # leave the field unset.
480 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]481 }
482
483 x__xgafv: string, V1 error format.
484 Allowed values
485 1 - v1 error format
486 2 - v2 error format
487
488Returns:
489 An object of the form:
490
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]491 { # An Identity and Access Management (IAM) policy, which specifies access
492 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]493 #
494 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]495 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
496 # `members` to a single `role`. Members can be user accounts, service accounts,
497 # Google groups, and domains (such as G Suite). A `role` is a named list of
498 # permissions; each `role` can be an IAM predefined role or a user-created
499 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]501 # Optionally, a `binding` can specify a `condition`, which is a logical
502 # expression that allows access to a resource only if the expression evaluates
503 # to `true`. A condition can add constraints based on attributes of the
504 # request, the resource, or both.
505 #
506 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]507 #
508 # {
509 # "bindings": [
510 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]511 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]512 # "members": [
513 # "user:mike@example.com",
514 # "group:admins@example.com",
515 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]516 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]517 # ]
518 # },
519 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]520 # "role": "roles/resourcemanager.organizationViewer",
521 # "members": ["user:eve@example.com"],
522 # "condition": {
523 # "title": "expirable access",
524 # "description": "Does not grant access after Sep 2020",
525 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
526 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]527 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]528 # ],
529 # "etag": "BwWWja0YfJA=",
530 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]531 # }
532 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]533 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]534 #
535 # bindings:
536 # - members:
537 # - user:mike@example.com
538 # - group:admins@example.com
539 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]540 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
541 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]542 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]543 # - user:eve@example.com
544 # role: roles/resourcemanager.organizationViewer
545 # condition:
546 # title: expirable access
547 # description: Does not grant access after Sep 2020
548 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
549 # - etag: BwWWja0YfJA=
550 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]551 #
552 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]553 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]554 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
555 { # Specifies the audit configuration for a service.
556 # The configuration determines which permission types are logged, and what
557 # identities, if any, are exempted from logging.
558 # An AuditConfig must have one or more AuditLogConfigs.
559 #
560 # If there are AuditConfigs for both `allServices` and a specific service,
561 # the union of the two AuditConfigs is used for that service: the log_types
562 # specified in each AuditConfig are enabled, and the exempted_members in each
563 # AuditLogConfig are exempted.
564 #
565 # Example Policy with multiple AuditConfigs:
566 #
567 # {
568 # "audit_configs": [
569 # {
570 # "service": "allServices"
571 # "audit_log_configs": [
572 # {
573 # "log_type": "DATA_READ",
574 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]575 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]576 # ]
577 # },
578 # {
579 # "log_type": "DATA_WRITE",
580 # },
581 # {
582 # "log_type": "ADMIN_READ",
583 # }
584 # ]
585 # },
586 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]587 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]588 # "audit_log_configs": [
589 # {
590 # "log_type": "DATA_READ",
591 # },
592 # {
593 # "log_type": "DATA_WRITE",
594 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]595 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]596 # ]
597 # }
598 # ]
599 # }
600 # ]
601 # }
602 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]603 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
604 # logging. It also exempts jose@example.com from DATA_READ logging, and
605 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]606 "auditLogConfigs": [ # The configuration for logging of each type of permission.
607 { # Provides the configuration for logging a type of permissions.
608 # Example:
609 #
610 # {
611 # "audit_log_configs": [
612 # {
613 # "log_type": "DATA_READ",
614 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]615 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]616 # ]
617 # },
618 # {
619 # "log_type": "DATA_WRITE",
620 # }
621 # ]
622 # }
623 #
624 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]625 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]626 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
627 # permission.
628 # Follows the same format of Binding.members.
629 "A String",
630 ],
631 "logType": "A String", # The log type that this config enables.
632 },
633 ],
634 "service": "A String", # Specifies a service that will be enabled for audit logging.
635 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
636 # `allServices` is a special value that covers all services.
637 },
638 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]639 "version": 42, # Specifies the format of the policy.
640 #
641 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
642 # are rejected.
643 #
644 # Any operation that affects conditional role bindings must specify version
645 # `3`. This requirement applies to the following operations:
646 #
647 # * Getting a policy that includes a conditional role binding
648 # * Adding a conditional role binding to a policy
649 # * Changing a conditional role binding in a policy
650 # * Removing any role binding, with or without a condition, from a policy
651 # that includes conditions
652 #
653 # **Important:** If you use IAM Conditions, you must include the `etag` field
654 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
655 # you to overwrite a version `3` policy with a version `1` policy, and all of
656 # the conditions in the version `3` policy are lost.
657 #
658 # If a policy does not include any conditions, operations on that policy may
659 # specify any valid version or leave the field unset.
660 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
661 # `condition` that determines how and when the `bindings` are applied. Each
662 # of the `bindings` must contain at least one member.
663 { # Associates `members` with a `role`.
664 "role": "A String", # Role that is assigned to `members`.
665 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
666 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
667 # `members` can have the following values:
668 #
669 # * `allUsers`: A special identifier that represents anyone who is
670 # on the internet; with or without a Google account.
671 #
672 # * `allAuthenticatedUsers`: A special identifier that represents anyone
673 # who is authenticated with a Google account or a service account.
674 #
675 # * `user:{emailid}`: An email address that represents a specific Google
676 # account. For example, `alice@example.com` .
677 #
678 #
679 # * `serviceAccount:{emailid}`: An email address that represents a service
680 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
681 #
682 # * `group:{emailid}`: An email address that represents a Google group.
683 # For example, `admins@example.com`.
684 #
685 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
686 # identifier) representing a user that has been recently deleted. For
687 # example, `alice@example.com?uid=123456789012345678901`. If the user is
688 # recovered, this value reverts to `user:{emailid}` and the recovered user
689 # retains the role in the binding.
690 #
691 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
692 # unique identifier) representing a service account that has been recently
693 # deleted. For example,
694 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
695 # If the service account is undeleted, this value reverts to
696 # `serviceAccount:{emailid}` and the undeleted service account retains the
697 # role in the binding.
698 #
699 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
700 # identifier) representing a Google group that has been recently
701 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
702 # the group is recovered, this value reverts to `group:{emailid}` and the
703 # recovered group retains the role in the binding.
704 #
705 #
706 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
707 # users of that domain. For example, `google.com` or `example.com`.
708 #
709 "A String",
710 ],
711 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
712 # NOTE: An unsatisfied condition will not allow user access via current
713 # binding. Different bindings, including their conditions, are examined
714 # independently.
715 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
716 # are documented at https://github.com/google/cel-spec.
717 #
718 # Example (Comparison):
719 #
720 # title: "Summary size limit"
721 # description: "Determines if a summary is less than 100 chars"
722 # expression: "document.summary.size() &lt; 100"
723 #
724 # Example (Equality):
725 #
726 # title: "Requestor is owner"
727 # description: "Determines if requestor is the document owner"
728 # expression: "document.owner == request.auth.claims.email"
729 #
730 # Example (Logic):
731 #
732 # title: "Public documents"
733 # description: "Determine whether the document should be publicly visible"
734 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
735 #
736 # Example (Data Manipulation):
737 #
738 # title: "Notification string"
739 # description: "Create a notification string with a timestamp."
740 # expression: "'New message received at ' + string(document.create_time)"
741 #
742 # The exact variables and functions that may be referenced within an expression
743 # are determined by the service that evaluates it. See the service
744 # documentation for additional information.
745 "description": "A String", # Optional. Description of the expression. This is a longer text which
746 # describes the expression, e.g. when hovered over it in a UI.
747 "expression": "A String", # Textual representation of an expression in Common Expression Language
748 # syntax.
749 "location": "A String", # Optional. String indicating the location of the expression for error
750 # reporting, e.g. a file name and a position in the file.
751 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
752 # its purpose. This can be used e.g. in UIs which allow to enter the
753 # expression.
754 },
755 },
756 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]757 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
758 # prevent simultaneous updates of a policy from overwriting each other.
759 # It is strongly suggested that systems make use of the `etag` in the
760 # read-modify-write cycle to perform policy updates in order to avoid race
761 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
762 # systems are expected to put that etag in the request to `setIamPolicy` to
763 # ensure that their change will be applied to the same version of the policy.
764 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]765 # **Important:** If you use IAM Conditions, you must include the `etag` field
766 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
767 # you to overwrite a version `3` policy with a version `1` policy, and all of
768 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]769 }</pre>
770</div>
771
772<div class="method">
773 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</code>
774 <pre>Lists all tables served from a specified instance.
775
776Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]777 parent: string, Required. The unique name of the instance for which tables should be listed.
778Values are of the form `projects/{project}/instances/{instance}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]779 pageToken: string, The value of `next_page_token` returned by a previous call.
780 x__xgafv: string, V1 error format.
781 Allowed values
782 1 - v1 error format
783 2 - v2 error format
784 pageSize: integer, Maximum number of results per page.
785
786A page_size of zero lets the server choose the number of items to return.
787A page_size which is strictly positive will return at most that many items.
788A negative page_size will cause an error.
789
790Following the first request, subsequent paginated calls are not required
791to pass a page_size. If a page_size is set in subsequent calls, it must
792match the page_size given in the first request.
793 view: string, The view to be applied to the returned tables' fields.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]794Only NAME_ONLY view (default) and REPLICATION_VIEW are supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]795
796Returns:
797 An object of the form:
798
799 { # Response message for
800 # google.bigtable.admin.v2.BigtableTableAdmin.ListTables
801 "nextPageToken": "A String", # Set if not all tables could be returned in a single response.
802 # Pass this value to `page_token` in another request to get the next
803 # page of results.
804 "tables": [ # The tables present in the requested instance.
805 { # A collection of user data indexed by row, column, and timestamp.
806 # Each table is served using the resources of its parent cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]807 "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]808 # If it could not be determined whether or not the table has data in a
809 # particular cluster (for example, if its zone is unavailable), then
810 # there will be an entry for the cluster with UNKNOWN `replication_status`.
811 # Views: `REPLICATION_VIEW`, `FULL`
812 "a_key": { # The state of a table's data in a particular cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]813 "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]814 },
815 },
816 "columnFamilies": { # (`CreationOnly`)
817 # The column families configured for this table, mapped by column family ID.
818 # Views: `SCHEMA_VIEW`, `FULL`
819 "a_key": { # A set of columns within a table which share a common configuration.
820 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
821 # Must serialize to at most 500 bytes.
822 #
823 # NOTE: Garbage collection executes opportunistically in the background, and
824 # so it's possible for reads to return a cell even if it matches the active
825 # GC expression for its family.
826 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
827 "rules": [ # Delete cells which would be deleted by any element of `rules`.
828 # Object with schema name: GcRule
829 ],
830 },
831 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
832 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
833 # Object with schema name: GcRule
834 ],
835 },
836 "maxAge": "A String", # Delete cells in a column older than the given age.
837 # Values must be at least one millisecond, and will be truncated to
838 # microsecond granularity.
839 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
840 },
841 },
842 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]843 "name": "A String", # Output only. The unique name of the table. Values are of the form
844 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/tables/_a-zA-Z0-9*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]845 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
846 "granularity": "A String", # (`CreationOnly`)
847 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
848 # this table. Timestamps not matching the granularity will be rejected.
849 # If unspecified at creation time, the value will be set to `MILLIS`.
850 # Views: `SCHEMA_VIEW`, `FULL`.
851 },
852 ],
853 }</pre>
854</div>
855
856<div class="method">
857 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
858 <pre>Retrieves the next page of results.
859
860Args:
861 previous_request: The request for the previous page. (required)
862 previous_response: The response from the request for the previous page. (required)
863
864Returns:
865 A request object that you can call 'execute()' on to request the next
866 page. Returns None if there are no more items in the collection.
867 </pre>
868</div>
869
870<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]871 <code class="details" id="modifyColumnFamilies">modifyColumnFamilies(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]872 <pre>Performs a series of column family modifications on the specified table.
873Either all or none of the modifications will occur before this method
874returns, but data requests received prior to that point may see a table
875where only some modifications have taken effect.
876
877Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]878 name: string, Required. The unique name of the table whose families should be modified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]879Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]880`projects/{project}/instances/{instance}/tables/{table}`. (required)
881 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]882 The object takes the form of:
883
884{ # Request message for
885 # google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]886 "modifications": [ # Required. Modifications to be atomically applied to the specified table's families.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]887 # Entries are applied in order, meaning that earlier modifications can be
888 # masked by later ones (in the case of repeated updates to the same family,
889 # for example).
890 { # A create, update, or delete of a particular column family.
891 "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
892 # one already exists with the given ID.
893 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
894 # Must serialize to at most 500 bytes.
895 #
896 # NOTE: Garbage collection executes opportunistically in the background, and
897 # so it's possible for reads to return a cell even if it matches the active
898 # GC expression for its family.
899 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
900 "rules": [ # Delete cells which would be deleted by any element of `rules`.
901 # Object with schema name: GcRule
902 ],
903 },
904 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
905 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
906 # Object with schema name: GcRule
907 ],
908 },
909 "maxAge": "A String", # Delete cells in a column older than the given age.
910 # Values must be at least one millisecond, and will be truncated to
911 # microsecond granularity.
912 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
913 },
914 },
915 "drop": True or False, # Drop (delete) the column family with the given ID, or fail if no such
916 # family exists.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]917 "id": "A String", # The ID of the column family to be modified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]918 "update": { # A set of columns within a table which share a common configuration. # Update an existing column family to the specified schema, or fail
919 # if no column family exists with the given ID.
920 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
921 # Must serialize to at most 500 bytes.
922 #
923 # NOTE: Garbage collection executes opportunistically in the background, and
924 # so it's possible for reads to return a cell even if it matches the active
925 # GC expression for its family.
926 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
927 "rules": [ # Delete cells which would be deleted by any element of `rules`.
928 # Object with schema name: GcRule
929 ],
930 },
931 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
932 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
933 # Object with schema name: GcRule
934 ],
935 },
936 "maxAge": "A String", # Delete cells in a column older than the given age.
937 # Values must be at least one millisecond, and will be truncated to
938 # microsecond granularity.
939 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
940 },
941 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]942 },
943 ],
944 }
945
946 x__xgafv: string, V1 error format.
947 Allowed values
948 1 - v1 error format
949 2 - v2 error format
950
951Returns:
952 An object of the form:
953
954 { # A collection of user data indexed by row, column, and timestamp.
955 # Each table is served using the resources of its parent cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]956 "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]957 # If it could not be determined whether or not the table has data in a
958 # particular cluster (for example, if its zone is unavailable), then
959 # there will be an entry for the cluster with UNKNOWN `replication_status`.
960 # Views: `REPLICATION_VIEW`, `FULL`
961 "a_key": { # The state of a table's data in a particular cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]962 "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]963 },
964 },
965 "columnFamilies": { # (`CreationOnly`)
966 # The column families configured for this table, mapped by column family ID.
967 # Views: `SCHEMA_VIEW`, `FULL`
968 "a_key": { # A set of columns within a table which share a common configuration.
969 "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
970 # Must serialize to at most 500 bytes.
971 #
972 # NOTE: Garbage collection executes opportunistically in the background, and
973 # so it's possible for reads to return a cell even if it matches the active
974 # GC expression for its family.
975 "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
976 "rules": [ # Delete cells which would be deleted by any element of `rules`.
977 # Object with schema name: GcRule
978 ],
979 },
980 "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
981 "rules": [ # Only delete cells which would be deleted by every element of `rules`.
982 # Object with schema name: GcRule
983 ],
984 },
985 "maxAge": "A String", # Delete cells in a column older than the given age.
986 # Values must be at least one millisecond, and will be truncated to
987 # microsecond granularity.
988 "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
989 },
990 },
991 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]992 "name": "A String", # Output only. The unique name of the table. Values are of the form
993 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/tables/_a-zA-Z0-9*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]994 # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
995 "granularity": "A String", # (`CreationOnly`)
996 # The granularity (i.e. `MILLIS`) at which timestamps are stored in
997 # this table. Timestamps not matching the granularity will be rejected.
998 # If unspecified at creation time, the value will be set to `MILLIS`.
999 # Views: `SCHEMA_VIEW`, `FULL`.
1000 }</pre>
1001</div>
1002
1003<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1004 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
1005 <pre>Sets the access control policy on a Table or Backup resource.
1006Replaces any existing policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1007
1008Args:
1009 resource: string, REQUIRED: The resource for which the policy is being specified.
1010See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1011 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1012 The object takes the form of:
1013
1014{ # Request message for `SetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1015 "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]1016 # the policy is limited to a few 10s of KB. An empty policy is a
1017 # valid policy but certain Cloud Platform services (such as Projects)
1018 # might reject them.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1019 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1020 #
1021 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1022 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1023 # `members` to a single `role`. Members can be user accounts, service accounts,
1024 # Google groups, and domains (such as G Suite). A `role` is a named list of
1025 # permissions; each `role` can be an IAM predefined role or a user-created
1026 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1027 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1028 # Optionally, a `binding` can specify a `condition`, which is a logical
1029 # expression that allows access to a resource only if the expression evaluates
1030 # to `true`. A condition can add constraints based on attributes of the
1031 # request, the resource, or both.
1032 #
1033 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1034 #
1035 # {
1036 # "bindings": [
1037 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1038 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1039 # "members": [
1040 # "user:mike@example.com",
1041 # "group:admins@example.com",
1042 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1043 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1044 # ]
1045 # },
1046 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1047 # "role": "roles/resourcemanager.organizationViewer",
1048 # "members": ["user:eve@example.com"],
1049 # "condition": {
1050 # "title": "expirable access",
1051 # "description": "Does not grant access after Sep 2020",
1052 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1053 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1054 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1055 # ],
1056 # "etag": "BwWWja0YfJA=",
1057 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1058 # }
1059 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1060 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1061 #
1062 # bindings:
1063 # - members:
1064 # - user:mike@example.com
1065 # - group:admins@example.com
1066 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1067 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1068 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1069 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1070 # - user:eve@example.com
1071 # role: roles/resourcemanager.organizationViewer
1072 # condition:
1073 # title: expirable access
1074 # description: Does not grant access after Sep 2020
1075 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1076 # - etag: BwWWja0YfJA=
1077 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1078 #
1079 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1080 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1081 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1082 { # Specifies the audit configuration for a service.
1083 # The configuration determines which permission types are logged, and what
1084 # identities, if any, are exempted from logging.
1085 # An AuditConfig must have one or more AuditLogConfigs.
1086 #
1087 # If there are AuditConfigs for both `allServices` and a specific service,
1088 # the union of the two AuditConfigs is used for that service: the log_types
1089 # specified in each AuditConfig are enabled, and the exempted_members in each
1090 # AuditLogConfig are exempted.
1091 #
1092 # Example Policy with multiple AuditConfigs:
1093 #
1094 # {
1095 # "audit_configs": [
1096 # {
1097 # "service": "allServices"
1098 # "audit_log_configs": [
1099 # {
1100 # "log_type": "DATA_READ",
1101 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1102 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1103 # ]
1104 # },
1105 # {
1106 # "log_type": "DATA_WRITE",
1107 # },
1108 # {
1109 # "log_type": "ADMIN_READ",
1110 # }
1111 # ]
1112 # },
1113 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1114 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1115 # "audit_log_configs": [
1116 # {
1117 # "log_type": "DATA_READ",
1118 # },
1119 # {
1120 # "log_type": "DATA_WRITE",
1121 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1122 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1123 # ]
1124 # }
1125 # ]
1126 # }
1127 # ]
1128 # }
1129 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1130 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1131 # logging. It also exempts jose@example.com from DATA_READ logging, and
1132 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1133 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1134 { # Provides the configuration for logging a type of permissions.
1135 # Example:
1136 #
1137 # {
1138 # "audit_log_configs": [
1139 # {
1140 # "log_type": "DATA_READ",
1141 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1142 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1143 # ]
1144 # },
1145 # {
1146 # "log_type": "DATA_WRITE",
1147 # }
1148 # ]
1149 # }
1150 #
1151 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1152 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1153 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1154 # permission.
1155 # Follows the same format of Binding.members.
1156 "A String",
1157 ],
1158 "logType": "A String", # The log type that this config enables.
1159 },
1160 ],
1161 "service": "A String", # Specifies a service that will be enabled for audit logging.
1162 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1163 # `allServices` is a special value that covers all services.
1164 },
1165 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1166 "version": 42, # Specifies the format of the policy.
1167 #
1168 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1169 # are rejected.
1170 #
1171 # Any operation that affects conditional role bindings must specify version
1172 # `3`. This requirement applies to the following operations:
1173 #
1174 # * Getting a policy that includes a conditional role binding
1175 # * Adding a conditional role binding to a policy
1176 # * Changing a conditional role binding in a policy
1177 # * Removing any role binding, with or without a condition, from a policy
1178 # that includes conditions
1179 #
1180 # **Important:** If you use IAM Conditions, you must include the `etag` field
1181 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1182 # you to overwrite a version `3` policy with a version `1` policy, and all of
1183 # the conditions in the version `3` policy are lost.
1184 #
1185 # If a policy does not include any conditions, operations on that policy may
1186 # specify any valid version or leave the field unset.
1187 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1188 # `condition` that determines how and when the `bindings` are applied. Each
1189 # of the `bindings` must contain at least one member.
1190 { # Associates `members` with a `role`.
1191 "role": "A String", # Role that is assigned to `members`.
1192 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1193 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1194 # `members` can have the following values:
1195 #
1196 # * `allUsers`: A special identifier that represents anyone who is
1197 # on the internet; with or without a Google account.
1198 #
1199 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1200 # who is authenticated with a Google account or a service account.
1201 #
1202 # * `user:{emailid}`: An email address that represents a specific Google
1203 # account. For example, `alice@example.com` .
1204 #
1205 #
1206 # * `serviceAccount:{emailid}`: An email address that represents a service
1207 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1208 #
1209 # * `group:{emailid}`: An email address that represents a Google group.
1210 # For example, `admins@example.com`.
1211 #
1212 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1213 # identifier) representing a user that has been recently deleted. For
1214 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1215 # recovered, this value reverts to `user:{emailid}` and the recovered user
1216 # retains the role in the binding.
1217 #
1218 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1219 # unique identifier) representing a service account that has been recently
1220 # deleted. For example,
1221 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1222 # If the service account is undeleted, this value reverts to
1223 # `serviceAccount:{emailid}` and the undeleted service account retains the
1224 # role in the binding.
1225 #
1226 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1227 # identifier) representing a Google group that has been recently
1228 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1229 # the group is recovered, this value reverts to `group:{emailid}` and the
1230 # recovered group retains the role in the binding.
1231 #
1232 #
1233 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1234 # users of that domain. For example, `google.com` or `example.com`.
1235 #
1236 "A String",
1237 ],
1238 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1239 # NOTE: An unsatisfied condition will not allow user access via current
1240 # binding. Different bindings, including their conditions, are examined
1241 # independently.
1242 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1243 # are documented at https://github.com/google/cel-spec.
1244 #
1245 # Example (Comparison):
1246 #
1247 # title: "Summary size limit"
1248 # description: "Determines if a summary is less than 100 chars"
1249 # expression: "document.summary.size() &lt; 100"
1250 #
1251 # Example (Equality):
1252 #
1253 # title: "Requestor is owner"
1254 # description: "Determines if requestor is the document owner"
1255 # expression: "document.owner == request.auth.claims.email"
1256 #
1257 # Example (Logic):
1258 #
1259 # title: "Public documents"
1260 # description: "Determine whether the document should be publicly visible"
1261 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1262 #
1263 # Example (Data Manipulation):
1264 #
1265 # title: "Notification string"
1266 # description: "Create a notification string with a timestamp."
1267 # expression: "'New message received at ' + string(document.create_time)"
1268 #
1269 # The exact variables and functions that may be referenced within an expression
1270 # are determined by the service that evaluates it. See the service
1271 # documentation for additional information.
1272 "description": "A String", # Optional. Description of the expression. This is a longer text which
1273 # describes the expression, e.g. when hovered over it in a UI.
1274 "expression": "A String", # Textual representation of an expression in Common Expression Language
1275 # syntax.
1276 "location": "A String", # Optional. String indicating the location of the expression for error
1277 # reporting, e.g. a file name and a position in the file.
1278 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
1279 # its purpose. This can be used e.g. in UIs which allow to enter the
1280 # expression.
1281 },
1282 },
1283 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1284 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1285 # prevent simultaneous updates of a policy from overwriting each other.
1286 # It is strongly suggested that systems make use of the `etag` in the
1287 # read-modify-write cycle to perform policy updates in order to avoid race
1288 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1289 # systems are expected to put that etag in the request to `setIamPolicy` to
1290 # ensure that their change will be applied to the same version of the policy.
1291 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1292 # **Important:** If you use IAM Conditions, you must include the `etag` field
1293 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1294 # you to overwrite a version `3` policy with a version `1` policy, and all of
1295 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1296 },
1297 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
1298 # the fields in the mask will be modified. If no mask is provided, the
1299 # following default mask is used:
1300 # paths: "bindings, etag"
1301 # This field is only used by Cloud IAM.
1302 }
1303
1304 x__xgafv: string, V1 error format.
1305 Allowed values
1306 1 - v1 error format
1307 2 - v2 error format
1308
1309Returns:
1310 An object of the form:
1311
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1312 { # An Identity and Access Management (IAM) policy, which specifies access
1313 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1314 #
1315 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1316 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1317 # `members` to a single `role`. Members can be user accounts, service accounts,
1318 # Google groups, and domains (such as G Suite). A `role` is a named list of
1319 # permissions; each `role` can be an IAM predefined role or a user-created
1320 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1321 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1322 # Optionally, a `binding` can specify a `condition`, which is a logical
1323 # expression that allows access to a resource only if the expression evaluates
1324 # to `true`. A condition can add constraints based on attributes of the
1325 # request, the resource, or both.
1326 #
1327 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1328 #
1329 # {
1330 # "bindings": [
1331 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1332 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1333 # "members": [
1334 # "user:mike@example.com",
1335 # "group:admins@example.com",
1336 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1337 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1338 # ]
1339 # },
1340 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1341 # "role": "roles/resourcemanager.organizationViewer",
1342 # "members": ["user:eve@example.com"],
1343 # "condition": {
1344 # "title": "expirable access",
1345 # "description": "Does not grant access after Sep 2020",
1346 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1347 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1348 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1349 # ],
1350 # "etag": "BwWWja0YfJA=",
1351 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1352 # }
1353 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1354 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1355 #
1356 # bindings:
1357 # - members:
1358 # - user:mike@example.com
1359 # - group:admins@example.com
1360 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1361 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1362 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1363 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1364 # - user:eve@example.com
1365 # role: roles/resourcemanager.organizationViewer
1366 # condition:
1367 # title: expirable access
1368 # description: Does not grant access after Sep 2020
1369 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1370 # - etag: BwWWja0YfJA=
1371 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1372 #
1373 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1374 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1375 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1376 { # Specifies the audit configuration for a service.
1377 # The configuration determines which permission types are logged, and what
1378 # identities, if any, are exempted from logging.
1379 # An AuditConfig must have one or more AuditLogConfigs.
1380 #
1381 # If there are AuditConfigs for both `allServices` and a specific service,
1382 # the union of the two AuditConfigs is used for that service: the log_types
1383 # specified in each AuditConfig are enabled, and the exempted_members in each
1384 # AuditLogConfig are exempted.
1385 #
1386 # Example Policy with multiple AuditConfigs:
1387 #
1388 # {
1389 # "audit_configs": [
1390 # {
1391 # "service": "allServices"
1392 # "audit_log_configs": [
1393 # {
1394 # "log_type": "DATA_READ",
1395 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1396 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1397 # ]
1398 # },
1399 # {
1400 # "log_type": "DATA_WRITE",
1401 # },
1402 # {
1403 # "log_type": "ADMIN_READ",
1404 # }
1405 # ]
1406 # },
1407 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1408 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1409 # "audit_log_configs": [
1410 # {
1411 # "log_type": "DATA_READ",
1412 # },
1413 # {
1414 # "log_type": "DATA_WRITE",
1415 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1416 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1417 # ]
1418 # }
1419 # ]
1420 # }
1421 # ]
1422 # }
1423 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1424 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1425 # logging. It also exempts jose@example.com from DATA_READ logging, and
1426 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1427 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1428 { # Provides the configuration for logging a type of permissions.
1429 # Example:
1430 #
1431 # {
1432 # "audit_log_configs": [
1433 # {
1434 # "log_type": "DATA_READ",
1435 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1436 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1437 # ]
1438 # },
1439 # {
1440 # "log_type": "DATA_WRITE",
1441 # }
1442 # ]
1443 # }
1444 #
1445 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1446 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1447 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1448 # permission.
1449 # Follows the same format of Binding.members.
1450 "A String",
1451 ],
1452 "logType": "A String", # The log type that this config enables.
1453 },
1454 ],
1455 "service": "A String", # Specifies a service that will be enabled for audit logging.
1456 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1457 # `allServices` is a special value that covers all services.
1458 },
1459 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1460 "version": 42, # Specifies the format of the policy.
1461 #
1462 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1463 # are rejected.
1464 #
1465 # Any operation that affects conditional role bindings must specify version
1466 # `3`. This requirement applies to the following operations:
1467 #
1468 # * Getting a policy that includes a conditional role binding
1469 # * Adding a conditional role binding to a policy
1470 # * Changing a conditional role binding in a policy
1471 # * Removing any role binding, with or without a condition, from a policy
1472 # that includes conditions
1473 #
1474 # **Important:** If you use IAM Conditions, you must include the `etag` field
1475 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1476 # you to overwrite a version `3` policy with a version `1` policy, and all of
1477 # the conditions in the version `3` policy are lost.
1478 #
1479 # If a policy does not include any conditions, operations on that policy may
1480 # specify any valid version or leave the field unset.
1481 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1482 # `condition` that determines how and when the `bindings` are applied. Each
1483 # of the `bindings` must contain at least one member.
1484 { # Associates `members` with a `role`.
1485 "role": "A String", # Role that is assigned to `members`.
1486 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1487 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1488 # `members` can have the following values:
1489 #
1490 # * `allUsers`: A special identifier that represents anyone who is
1491 # on the internet; with or without a Google account.
1492 #
1493 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1494 # who is authenticated with a Google account or a service account.
1495 #
1496 # * `user:{emailid}`: An email address that represents a specific Google
1497 # account. For example, `alice@example.com` .
1498 #
1499 #
1500 # * `serviceAccount:{emailid}`: An email address that represents a service
1501 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1502 #
1503 # * `group:{emailid}`: An email address that represents a Google group.
1504 # For example, `admins@example.com`.
1505 #
1506 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1507 # identifier) representing a user that has been recently deleted. For
1508 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1509 # recovered, this value reverts to `user:{emailid}` and the recovered user
1510 # retains the role in the binding.
1511 #
1512 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1513 # unique identifier) representing a service account that has been recently
1514 # deleted. For example,
1515 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1516 # If the service account is undeleted, this value reverts to
1517 # `serviceAccount:{emailid}` and the undeleted service account retains the
1518 # role in the binding.
1519 #
1520 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1521 # identifier) representing a Google group that has been recently
1522 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1523 # the group is recovered, this value reverts to `group:{emailid}` and the
1524 # recovered group retains the role in the binding.
1525 #
1526 #
1527 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1528 # users of that domain. For example, `google.com` or `example.com`.
1529 #
1530 "A String",
1531 ],
1532 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1533 # NOTE: An unsatisfied condition will not allow user access via current
1534 # binding. Different bindings, including their conditions, are examined
1535 # independently.
1536 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1537 # are documented at https://github.com/google/cel-spec.
1538 #
1539 # Example (Comparison):
1540 #
1541 # title: "Summary size limit"
1542 # description: "Determines if a summary is less than 100 chars"
1543 # expression: "document.summary.size() &lt; 100"
1544 #
1545 # Example (Equality):
1546 #
1547 # title: "Requestor is owner"
1548 # description: "Determines if requestor is the document owner"
1549 # expression: "document.owner == request.auth.claims.email"
1550 #
1551 # Example (Logic):
1552 #
1553 # title: "Public documents"
1554 # description: "Determine whether the document should be publicly visible"
1555 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1556 #
1557 # Example (Data Manipulation):
1558 #
1559 # title: "Notification string"
1560 # description: "Create a notification string with a timestamp."
1561 # expression: "'New message received at ' + string(document.create_time)"
1562 #
1563 # The exact variables and functions that may be referenced within an expression
1564 # are determined by the service that evaluates it. See the service
1565 # documentation for additional information.
1566 "description": "A String", # Optional. Description of the expression. This is a longer text which
1567 # describes the expression, e.g. when hovered over it in a UI.
1568 "expression": "A String", # Textual representation of an expression in Common Expression Language
1569 # syntax.
1570 "location": "A String", # Optional. String indicating the location of the expression for error
1571 # reporting, e.g. a file name and a position in the file.
1572 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
1573 # its purpose. This can be used e.g. in UIs which allow to enter the
1574 # expression.
1575 },
1576 },
1577 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1578 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1579 # prevent simultaneous updates of a policy from overwriting each other.
1580 # It is strongly suggested that systems make use of the `etag` in the
1581 # read-modify-write cycle to perform policy updates in order to avoid race
1582 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1583 # systems are expected to put that etag in the request to `setIamPolicy` to
1584 # ensure that their change will be applied to the same version of the policy.
1585 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1586 # **Important:** If you use IAM Conditions, you must include the `etag` field
1587 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1588 # you to overwrite a version `3` policy with a version `1` policy, and all of
1589 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1590 }</pre>
1591</div>
1592
1593<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1594 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1595 <pre>Returns permissions that the caller has on the specified table resource.
1596
1597Args:
1598 resource: string, REQUIRED: The resource for which the policy detail is being requested.
1599See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1600 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1601 The object takes the form of:
1602
1603{ # Request message for `TestIamPermissions` method.
1604 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1605 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1606 # information see
1607 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1608 "A String",
1609 ],
1610 }
1611
1612 x__xgafv: string, V1 error format.
1613 Allowed values
1614 1 - v1 error format
1615 2 - v2 error format
1616
1617Returns:
1618 An object of the form:
1619
1620 { # Response message for `TestIamPermissions` method.
1621 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1622 # allowed.
1623 "A String",
1624 ],
1625 }</pre>
1626</div>
1627
1628</body></html>