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="cloudasset_v1beta1.html">Cloud Asset API</a> . <a href="cloudasset_v1beta1.projects.html">projects</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="cloudasset_v1beta1.projects.operations.html">operations()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the operations Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 83 | <code><a href="#batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <p class="firstline">Batch gets the update history of assets that overlap a time window.</p> |
| 85 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 86 | <code><a href="#exportAssets">exportAssets(parent, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 87 | <p class="firstline">Exports assets with time and resource types to a given Cloud Storage</p> |
| 88 | <h3>Method Details</h3> |
| 89 | <div class="method"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 90 | <code class="details" id="batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <pre>Batch gets the update history of assets that overlap a time window. |
| 92 | For RESOURCE content, this API outputs history with asset in both |
| 93 | non-delete or deleted status. |
| 94 | For IAM_POLICY content, this API outputs history when the asset and its |
| 95 | attached IAM POLICY both exist. This can create gaps in the output history. |
| 96 | If a specified asset does not exist, this API returns an INVALID_ARGUMENT |
| 97 | error. |
| 98 | |
| 99 | Args: |
| 100 | parent: string, Required. The relative name of the root asset. It can only be an |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 101 | organization number (such as "organizations/123"), a project ID (such as |
| 102 | "projects/my-project-id")", or a project number (such as "projects/12345"). (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 103 | contentType: string, Optional. The content type. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 104 | readTimeWindow_endTime: string, End time of the time window (inclusive). |
| 105 | Current timestamp if not specified. |
| 106 | readTimeWindow_startTime: string, Start time of the time window (exclusive). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | assetNames: string, A list of the full names of the assets. For example: |
| 108 | `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 109 | See [Resource |
| 110 | Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 111 | for more info. |
| 112 | |
| 113 | The request becomes a no-op if the asset name list is empty, and the max |
| 114 | size of the asset name list is 100 in one request. (repeated) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 115 | x__xgafv: string, V1 error format. |
| 116 | Allowed values |
| 117 | 1 - v1 error format |
| 118 | 2 - v2 error format |
| 119 | |
| 120 | Returns: |
| 121 | An object of the form: |
| 122 | |
| 123 | { # Batch get assets history response. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 124 | "assets": [ # A list of assets with valid time windows. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | { # Temporal asset. In addition to the asset, the temporal asset includes the |
| 126 | # status of the asset and valid from and to time of it. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 127 | "deleted": True or False, # If the asset is deleted or not. |
| 128 | "window": { # A time window of (start_time, end_time]. # The time window when the asset data and state was observed. |
| 129 | "endTime": "A String", # End time of the time window (inclusive). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 130 | # Current timestamp if not specified. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 131 | "startTime": "A String", # Start time of the time window (exclusive). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 132 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 133 | "asset": { # Cloud asset. This includes all Google Cloud Platform resources, # Asset. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 134 | # Cloud IAM policies, and other non-GCP assets. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 135 | "name": "A String", # The full name of the asset. For example: |
| 136 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 137 | # See [Resource |
| 138 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 139 | # for more information. |
| 140 | "iamPolicy": { # An Identity and Access Management (IAM) policy, which specifies access # Representation of the actual Cloud IAM policy set on a cloud resource. For |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 141 | # each resource, there must be at most one Cloud IAM policy set on it. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 142 | # controls for Google Cloud resources. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 143 | # |
| 144 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 145 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 146 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 147 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 148 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 149 | # custom role. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 150 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 151 | # Optionally, a `binding` can specify a `condition`, which is a logical |
| 152 | # expression that allows access to a resource only if the expression evaluates |
| 153 | # to `true`. A condition can add constraints based on attributes of the |
| 154 | # request, the resource, or both. |
| 155 | # |
| 156 | # **JSON example:** |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 157 | # |
| 158 | # { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 159 | # "bindings": [ |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 160 | # { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 161 | # "role": "roles/resourcemanager.organizationAdmin", |
| 162 | # "members": [ |
| 163 | # "user:mike@example.com", |
| 164 | # "group:admins@example.com", |
| 165 | # "domain:google.com", |
| 166 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 167 | # ] |
| 168 | # }, |
| 169 | # { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 170 | # "role": "roles/resourcemanager.organizationViewer", |
| 171 | # "members": ["user:eve@example.com"], |
| 172 | # "condition": { |
| 173 | # "title": "expirable access", |
| 174 | # "description": "Does not grant access after Sep 2020", |
| 175 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 176 | # } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 177 | # } |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 178 | # ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 179 | # "etag": "BwWWja0YfJA=", |
| 180 | # "version": 3 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 181 | # } |
| 182 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 183 | # **YAML example:** |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 184 | # |
| 185 | # bindings: |
| 186 | # - members: |
| 187 | # - user:mike@example.com |
| 188 | # - group:admins@example.com |
| 189 | # - domain:google.com |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 190 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 191 | # role: roles/resourcemanager.organizationAdmin |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 192 | # - members: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 193 | # - user:eve@example.com |
| 194 | # role: roles/resourcemanager.organizationViewer |
| 195 | # condition: |
| 196 | # title: expirable access |
| 197 | # description: Does not grant access after Sep 2020 |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 198 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 199 | # - etag: BwWWja0YfJA= |
| 200 | # - version: 3 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 201 | # |
| 202 | # For a description of IAM and its features, see the |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 203 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 204 | "version": 42, # Specifies the format of the policy. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 205 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 206 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 207 | # are rejected. |
| 208 | # |
| 209 | # Any operation that affects conditional role bindings must specify version |
| 210 | # `3`. This requirement applies to the following operations: |
| 211 | # |
| 212 | # * Getting a policy that includes a conditional role binding |
| 213 | # * Adding a conditional role binding to a policy |
| 214 | # * Changing a conditional role binding in a policy |
| 215 | # * Removing any role binding, with or without a condition, from a policy |
| 216 | # that includes conditions |
| 217 | # |
| 218 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 219 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 220 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 221 | # the conditions in the version `3` policy are lost. |
| 222 | # |
| 223 | # If a policy does not include any conditions, operations on that policy may |
| 224 | # specify any valid version or leave the field unset. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 225 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 226 | { # Specifies the audit configuration for a service. |
| 227 | # The configuration determines which permission types are logged, and what |
| 228 | # identities, if any, are exempted from logging. |
| 229 | # An AuditConfig must have one or more AuditLogConfigs. |
| 230 | # |
| 231 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 232 | # the union of the two AuditConfigs is used for that service: the log_types |
| 233 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 234 | # AuditLogConfig are exempted. |
| 235 | # |
| 236 | # Example Policy with multiple AuditConfigs: |
| 237 | # |
| 238 | # { |
| 239 | # "audit_configs": [ |
| 240 | # { |
| 241 | # "service": "allServices" |
| 242 | # "audit_log_configs": [ |
| 243 | # { |
| 244 | # "log_type": "DATA_READ", |
| 245 | # "exempted_members": [ |
| 246 | # "user:jose@example.com" |
| 247 | # ] |
| 248 | # }, |
| 249 | # { |
| 250 | # "log_type": "DATA_WRITE", |
| 251 | # }, |
| 252 | # { |
| 253 | # "log_type": "ADMIN_READ", |
| 254 | # } |
| 255 | # ] |
| 256 | # }, |
| 257 | # { |
| 258 | # "service": "sampleservice.googleapis.com" |
| 259 | # "audit_log_configs": [ |
| 260 | # { |
| 261 | # "log_type": "DATA_READ", |
| 262 | # }, |
| 263 | # { |
| 264 | # "log_type": "DATA_WRITE", |
| 265 | # "exempted_members": [ |
| 266 | # "user:aliya@example.com" |
| 267 | # ] |
| 268 | # } |
| 269 | # ] |
| 270 | # } |
| 271 | # ] |
| 272 | # } |
| 273 | # |
| 274 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 275 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 276 | # aliya@example.com from DATA_WRITE logging. |
| 277 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 278 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 279 | # `allServices` is a special value that covers all services. |
| 280 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 281 | { # Provides the configuration for logging a type of permissions. |
| 282 | # Example: |
| 283 | # |
| 284 | # { |
| 285 | # "audit_log_configs": [ |
| 286 | # { |
| 287 | # "log_type": "DATA_READ", |
| 288 | # "exempted_members": [ |
| 289 | # "user:jose@example.com" |
| 290 | # ] |
| 291 | # }, |
| 292 | # { |
| 293 | # "log_type": "DATA_WRITE", |
| 294 | # } |
| 295 | # ] |
| 296 | # } |
| 297 | # |
| 298 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 299 | # jose@example.com from DATA_READ logging. |
| 300 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 301 | # permission. |
| 302 | # Follows the same format of Binding.members. |
| 303 | "A String", |
| 304 | ], |
| 305 | "logType": "A String", # The log type that this config enables. |
| 306 | }, |
| 307 | ], |
| 308 | }, |
| 309 | ], |
| 310 | "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] | 311 | # `condition` that determines how and when the `bindings` are applied. Each |
| 312 | # of the `bindings` must contain at least one member. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 313 | { # Associates `members` with a `role`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 314 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 315 | # NOTE: An unsatisfied condition will not allow user access via current |
| 316 | # binding. Different bindings, including their conditions, are examined |
| 317 | # independently. |
| 318 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 319 | # are documented at https://github.com/google/cel-spec. |
| 320 | # |
| 321 | # Example (Comparison): |
| 322 | # |
| 323 | # title: "Summary size limit" |
| 324 | # description: "Determines if a summary is less than 100 chars" |
| 325 | # expression: "document.summary.size() < 100" |
| 326 | # |
| 327 | # Example (Equality): |
| 328 | # |
| 329 | # title: "Requestor is owner" |
| 330 | # description: "Determines if requestor is the document owner" |
| 331 | # expression: "document.owner == request.auth.claims.email" |
| 332 | # |
| 333 | # Example (Logic): |
| 334 | # |
| 335 | # title: "Public documents" |
| 336 | # description: "Determine whether the document should be publicly visible" |
| 337 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 338 | # |
| 339 | # Example (Data Manipulation): |
| 340 | # |
| 341 | # title: "Notification string" |
| 342 | # description: "Create a notification string with a timestamp." |
| 343 | # expression: "'New message received at ' + string(document.create_time)" |
| 344 | # |
| 345 | # The exact variables and functions that may be referenced within an expression |
| 346 | # are determined by the service that evaluates it. See the service |
| 347 | # documentation for additional information. |
| 348 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 349 | # syntax. |
| 350 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 351 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 352 | # expression. |
| 353 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 354 | # reporting, e.g. a file name and a position in the file. |
| 355 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 356 | # describes the expression, e.g. when hovered over it in a UI. |
| 357 | }, |
| 358 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 359 | # `members` can have the following values: |
| 360 | # |
| 361 | # * `allUsers`: A special identifier that represents anyone who is |
| 362 | # on the internet; with or without a Google account. |
| 363 | # |
| 364 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 365 | # who is authenticated with a Google account or a service account. |
| 366 | # |
| 367 | # * `user:{emailid}`: An email address that represents a specific Google |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 368 | # account. For example, `alice@example.com` . |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 369 | # |
| 370 | # |
| 371 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 372 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 373 | # |
| 374 | # * `group:{emailid}`: An email address that represents a Google group. |
| 375 | # For example, `admins@example.com`. |
| 376 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 377 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 378 | # identifier) representing a user that has been recently deleted. For |
| 379 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 380 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 381 | # retains the role in the binding. |
| 382 | # |
| 383 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 384 | # unique identifier) representing a service account that has been recently |
| 385 | # deleted. For example, |
| 386 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 387 | # If the service account is undeleted, this value reverts to |
| 388 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 389 | # role in the binding. |
| 390 | # |
| 391 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 392 | # identifier) representing a Google group that has been recently |
| 393 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 394 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 395 | # recovered group retains the role in the binding. |
| 396 | # |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 397 | # |
| 398 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 399 | # users of that domain. For example, `google.com` or `example.com`. |
| 400 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 401 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 402 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 403 | "role": "A String", # Role that is assigned to `members`. |
| 404 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 405 | }, |
| 406 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 407 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 408 | # prevent simultaneous updates of a policy from overwriting each other. |
| 409 | # It is strongly suggested that systems make use of the `etag` in the |
| 410 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 411 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 412 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 413 | # ensure that their change will be applied to the same version of the policy. |
| 414 | # |
| 415 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 416 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 417 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 418 | # the conditions in the version `3` policy are lost. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 419 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 420 | "resource": { # Representation of a cloud resource. # Representation of the resource. |
| 421 | "resourceUrl": "A String", # The REST URL for accessing the resource. An HTTP GET operation using this |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 422 | # URL returns the resource itself. |
| 423 | # Example: |
| 424 | # `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. |
| 425 | # It will be left unspecified for resources without a REST API. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 426 | "discoveryName": "A String", # The JSON schema name listed in the discovery document. |
| 427 | # Example: "Project". It will be left unspecified for resources (such as |
| 428 | # Cloud Bigtable) without a discovery-based API. |
| 429 | "version": "A String", # The API version. Example: "v1". |
| 430 | "data": { # The content of the resource, in which some sensitive fields are scrubbed |
| 431 | # away and may not be present. |
| 432 | "a_key": "", # Properties of the object. |
| 433 | }, |
| 434 | "discoveryDocumentUri": "A String", # The URL of the discovery document containing the resource's JSON schema. |
| 435 | # For example: |
| 436 | # `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. |
| 437 | # It will be left unspecified for resources without a discovery-based API, |
| 438 | # such as Cloud Bigtable. |
| 439 | "parent": "A String", # The full name of the immediate parent of this resource. See |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 440 | # [Resource |
| 441 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 442 | # for more information. |
| 443 | # |
| 444 | # For GCP assets, it is the parent resource defined in the [Cloud IAM policy |
| 445 | # hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). |
| 446 | # For example: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 447 | # `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 448 | # |
| 449 | # For third-party assets, it is up to the users to define. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 450 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 451 | "assetType": "A String", # Type of the asset. Example: "google.compute.Disk". |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 452 | }, |
| 453 | }, |
| 454 | ], |
| 455 | }</pre> |
| 456 | </div> |
| 457 | |
| 458 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 459 | <code class="details" id="exportAssets">exportAssets(parent, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 460 | <pre>Exports assets with time and resource types to a given Cloud Storage |
| 461 | location. The output format is newline-delimited JSON. |
| 462 | This API implements the google.longrunning.Operation API allowing you |
| 463 | to keep track of the export. |
| 464 | |
| 465 | Args: |
| 466 | parent: string, Required. The relative name of the root asset. This can only be an |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 467 | organization number (such as "organizations/123"), a project ID (such as |
| 468 | "projects/my-project-id"), a project number (such as "projects/12345"), or |
| 469 | a folder number (such as "folders/123"). (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 470 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 471 | The object takes the form of: |
| 472 | |
| 473 | { # Export asset request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 474 | "readTime": "A String", # Timestamp to take an asset snapshot. This can only be set to a timestamp |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 475 | # between 2018-10-02 UTC (inclusive) and the current time. If not specified, |
| 476 | # the current time will be used. Due to delays in resource data collection |
| 477 | # and indexing, there is a volatile window during which running the same |
| 478 | # query may get different results. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 479 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name will be |
| 480 | # returned. |
| 481 | "outputConfig": { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output |
| 482 | # to. All results will be in newline delimited JSON format. |
| 483 | "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage. |
| 484 | "uri": "A String", # The uri of the Cloud Storage object. It's the same uri that is used by |
| 485 | # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and |
| 486 | # Editing Object |
| 487 | # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) |
| 488 | # for more information. |
| 489 | "uriPrefix": "A String", # The uri prefix of all generated Cloud Storage objects. For example: |
| 490 | # "gs://bucket_name/object_name_prefix". Each object uri is in format: |
| 491 | # "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only |
| 492 | # contains assets for that type. <shard number> starts from 0. For example: |
| 493 | # "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first |
| 494 | # shard of output objects containing all google.compute.disk assets. |
| 495 | # An INVALID_ARGUMENT error will be returned if file with the same name |
| 496 | # "gs://bucket_name/object_name_prefix" already exists. |
| 497 | }, |
| 498 | }, |
| 499 | "assetTypes": [ # A list of asset types of which to take a snapshot for. For example: |
| 500 | # "google.compute.Disk". If specified, only matching assets will be returned. |
| 501 | # See [Introduction to Cloud Asset |
| 502 | # Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) |
| 503 | # for all supported asset types. |
| 504 | "A String", |
| 505 | ], |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 506 | } |
| 507 | |
| 508 | x__xgafv: string, V1 error format. |
| 509 | Allowed values |
| 510 | 1 - v1 error format |
| 511 | 2 - v2 error format |
| 512 | |
| 513 | Returns: |
| 514 | An object of the form: |
| 515 | |
| 516 | { # This resource represents a long-running operation that is the result of a |
| 517 | # network API call. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 518 | "response": { # The normal response of the operation in case of success. If the original |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 519 | # method returns no data on success, such as `Delete`, the response is |
| 520 | # `google.protobuf.Empty`. If the original method is standard |
| 521 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 522 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 523 | # is the original method name. For example, if the original method name |
| 524 | # is `TakeSnapshot()`, the inferred response type is |
| 525 | # `TakeSnapshotResponse`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 526 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 527 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 528 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 529 | # originally returns it. If you use the default HTTP mapping, the |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 530 | # `name` should be a resource name ending with `operations/{unique_id}`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 531 | "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. |
| 532 | # different programming environments, including REST APIs and RPC APIs. It is |
| 533 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 534 | # three pieces of data: error code, error message, and error details. |
| 535 | # |
| 536 | # You can find out more about this error model and how to work with it in the |
| 537 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 538 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 539 | # message types for APIs to use. |
| 540 | { |
| 541 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 542 | }, |
| 543 | ], |
| 544 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 545 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 546 | # user-facing error message should be localized and sent in the |
| 547 | # google.rpc.Status.details field, or localized by the client. |
| 548 | }, |
| 549 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 550 | # contains progress information and common metadata such as create time. |
| 551 | # Some services might not provide such metadata. Any method that returns a |
| 552 | # long-running operation should document the metadata type, if any. |
| 553 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 554 | }, |
| 555 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 556 | # If `true`, the operation is completed, and either `error` or `response` is |
| 557 | # available. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 558 | }</pre> |
| 559 | </div> |
| 560 | |
| 561 | </body></html> |