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