blob: 58faf93b600ccafd3e3867bae844d188f081c35b [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="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 Kim65020912020-05-20 12:08:20 -070083 <code><a href="#batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070084<p class="firstline">Batch gets the update history of assets that overlap a time window.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070086 <code><a href="#exportAssets">exportAssets(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070087<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 Kim65020912020-05-20 12:08:20 -070090 <code class="details" id="batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091 <pre>Batch gets the update history of assets that overlap a time window.
92For RESOURCE content, this API outputs history with asset in both
93non-delete or deleted status.
94For IAM_POLICY content, this API outputs history when the asset and its
95attached IAM POLICY both exist. This can create gaps in the output history.
96If a specified asset does not exist, this API returns an INVALID_ARGUMENT
97error.
98
99Args:
100 parent: string, Required. The relative name of the root asset. It can only be an
Bu Sun Kim65020912020-05-20 12:08:20 -0700101organization number (such as &quot;organizations/123&quot;), a project ID (such as
102&quot;projects/my-project-id&quot;)&quot;, or a project number (such as &quot;projects/12345&quot;). (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700103 contentType: string, Optional. The content type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 readTimeWindow_endTime: string, End time of the time window (inclusive).
105Current timestamp if not specified.
106 readTimeWindow_startTime: string, Start time of the time window (exclusive).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700107 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`.
109See [Resource
110Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
111for more info.
112
113The request becomes a no-op if the asset name list is empty, and the max
114size of the asset name list is 100 in one request. (repeated)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700115 x__xgafv: string, V1 error format.
116 Allowed values
117 1 - v1 error format
118 2 - v2 error format
119
120Returns:
121 An object of the form:
122
123 { # Batch get assets history response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700124 &quot;assets&quot;: [ # A list of assets with valid time windows.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700125 { # 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 Kim65020912020-05-20 12:08:20 -0700127 &quot;deleted&quot;: True or False, # If the asset is deleted or not.
128 &quot;window&quot;: { # A time window of (start_time, end_time]. # The time window when the asset data and state was observed.
129 &quot;endTime&quot;: &quot;A String&quot;, # End time of the time window (inclusive).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700130 # Current timestamp if not specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700131 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the time window (exclusive).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700132 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700133 &quot;asset&quot;: { # Cloud asset. This includes all Google Cloud Platform resources, # Asset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700134 # Cloud IAM policies, and other non-GCP assets.
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 &quot;name&quot;: &quot;A String&quot;, # 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 &quot;iamPolicy&quot;: { # 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 Kim715bd7f2019-06-14 16:50:42 -0700141 # each resource, there must be at most one Cloud IAM policy set on it.
Dan O'Mearadd494642020-05-01 07:42:23 -0700142 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700143 #
144 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700145 # 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 Kim715bd7f2019-06-14 16:50:42 -0700150 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700151 # 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 Kim715bd7f2019-06-14 16:50:42 -0700157 #
158 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700159 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700160 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700161 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
162 # &quot;members&quot;: [
163 # &quot;user:mike@example.com&quot;,
164 # &quot;group:admins@example.com&quot;,
165 # &quot;domain:google.com&quot;,
166 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700167 # ]
168 # },
169 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700170 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
171 # &quot;members&quot;: [&quot;user:eve@example.com&quot;],
172 # &quot;condition&quot;: {
173 # &quot;title&quot;: &quot;expirable access&quot;,
174 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
175 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700176 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700177 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700178 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700179 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
180 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700181 # }
182 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700183 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700184 #
185 # bindings:
186 # - members:
187 # - user:mike@example.com
188 # - group:admins@example.com
189 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700190 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
191 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700192 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700193 # - 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 Kim65020912020-05-20 12:08:20 -0700198 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700199 # - etag: BwWWja0YfJA=
200 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700201 #
202 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700203 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 &quot;version&quot;: 42, # Specifies the format of the policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700205 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700206 # 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 Kim65020912020-05-20 12:08:20 -0700225 &quot;auditConfigs&quot;: [ # 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 # &quot;audit_configs&quot;: [
240 # {
241 # &quot;service&quot;: &quot;allServices&quot;
242 # &quot;audit_log_configs&quot;: [
243 # {
244 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
245 # &quot;exempted_members&quot;: [
246 # &quot;user:jose@example.com&quot;
247 # ]
248 # },
249 # {
250 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
251 # },
252 # {
253 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;,
254 # }
255 # ]
256 # },
257 # {
258 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;
259 # &quot;audit_log_configs&quot;: [
260 # {
261 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
262 # },
263 # {
264 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
265 # &quot;exempted_members&quot;: [
266 # &quot;user:aliya@example.com&quot;
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 &quot;service&quot;: &quot;A String&quot;, # 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 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
281 { # Provides the configuration for logging a type of permissions.
282 # Example:
283 #
284 # {
285 # &quot;audit_log_configs&quot;: [
286 # {
287 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
288 # &quot;exempted_members&quot;: [
289 # &quot;user:jose@example.com&quot;
290 # ]
291 # },
292 # {
293 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
294 # }
295 # ]
296 # }
297 #
298 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
299 # jose@example.com from DATA_READ logging.
300 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
301 # permission.
302 # Follows the same format of Binding.members.
303 &quot;A String&quot;,
304 ],
305 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
306 },
307 ],
308 },
309 ],
310 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a
Dan O'Mearadd494642020-05-01 07:42:23 -0700311 # `condition` that determines how and when the `bindings` are applied. Each
312 # of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700313 { # Associates `members` with a `role`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700314 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot;
324 # description: &quot;Determines if a summary is less than 100 chars&quot;
325 # expression: &quot;document.summary.size() &lt; 100&quot;
326 #
327 # Example (Equality):
328 #
329 # title: &quot;Requestor is owner&quot;
330 # description: &quot;Determines if requestor is the document owner&quot;
331 # expression: &quot;document.owner == request.auth.claims.email&quot;
332 #
333 # Example (Logic):
334 #
335 # title: &quot;Public documents&quot;
336 # description: &quot;Determine whether the document should be publicly visible&quot;
337 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
338 #
339 # Example (Data Manipulation):
340 #
341 # title: &quot;Notification string&quot;
342 # description: &quot;Create a notification string with a timestamp.&quot;
343 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
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 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
349 # syntax.
350 &quot;title&quot;: &quot;A String&quot;, # 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 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
354 # reporting, e.g. a file name and a position in the file.
355 &quot;description&quot;: &quot;A String&quot;, # 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 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700359 # `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'Mearadd494642020-05-01 07:42:23 -0700368 # account. For example, `alice@example.com` .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700369 #
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'Mearadd494642020-05-01 07:42:23 -0700377 # * `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 Kim715bd7f2019-06-14 16:50:42 -0700397 #
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 Kim65020912020-05-20 12:08:20 -0700401 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700402 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700403 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
404 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700405 },
406 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700407 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
Dan O'Mearadd494642020-05-01 07:42:23 -0700408 # 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 Kim715bd7f2019-06-14 16:50:42 -0700419 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700420 &quot;resource&quot;: { # Representation of a cloud resource. # Representation of the resource.
421 &quot;resourceUrl&quot;: &quot;A String&quot;, # The REST URL for accessing the resource. An HTTP GET operation using this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422 # 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 Kim65020912020-05-20 12:08:20 -0700426 &quot;discoveryName&quot;: &quot;A String&quot;, # The JSON schema name listed in the discovery document.
427 # Example: &quot;Project&quot;. It will be left unspecified for resources (such as
428 # Cloud Bigtable) without a discovery-based API.
429 &quot;version&quot;: &quot;A String&quot;, # The API version. Example: &quot;v1&quot;.
430 &quot;data&quot;: { # The content of the resource, in which some sensitive fields are scrubbed
431 # away and may not be present.
432 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
433 },
434 &quot;discoveryDocumentUri&quot;: &quot;A String&quot;, # The URL of the discovery document containing the resource&#x27;s JSON schema.
435 # For example:
436 # `&quot;https://www.googleapis.com/discovery/v1/apis/compute/v1/rest&quot;`.
437 # It will be left unspecified for resources without a discovery-based API,
438 # such as Cloud Bigtable.
439 &quot;parent&quot;: &quot;A String&quot;, # The full name of the immediate parent of this resource. See
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700440 # [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 Kim65020912020-05-20 12:08:20 -0700447 # `&quot;//cloudresourcemanager.googleapis.com/projects/my_project_123&quot;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700448 #
449 # For third-party assets, it is up to the users to define.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700450 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700451 &quot;assetType&quot;: &quot;A String&quot;, # Type of the asset. Example: &quot;google.compute.Disk&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700452 },
453 },
454 ],
455 }</pre>
456</div>
457
458<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700459 <code class="details" id="exportAssets">exportAssets(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700460 <pre>Exports assets with time and resource types to a given Cloud Storage
461location. The output format is newline-delimited JSON.
462This API implements the google.longrunning.Operation API allowing you
463to keep track of the export.
464
465Args:
466 parent: string, Required. The relative name of the root asset. This can only be an
Bu Sun Kim65020912020-05-20 12:08:20 -0700467organization number (such as &quot;organizations/123&quot;), a project ID (such as
468&quot;projects/my-project-id&quot;), a project number (such as &quot;projects/12345&quot;), or
469a folder number (such as &quot;folders/123&quot;). (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700470 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700471 The object takes the form of:
472
473{ # Export asset request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700474 &quot;readTime&quot;: &quot;A String&quot;, # Timestamp to take an asset snapshot. This can only be set to a timestamp
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700475 # 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 Kim65020912020-05-20 12:08:20 -0700479 &quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name will be
480 # returned.
481 &quot;outputConfig&quot;: { # 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 &quot;gcsDestination&quot;: { # A Cloud Storage location. # Destination on Cloud Storage.
484 &quot;uri&quot;: &quot;A String&quot;, # The uri of the Cloud Storage object. It&#x27;s the same uri that is used by
485 # gsutil. For example: &quot;gs://bucket_name/object_name&quot;. See [Viewing and
486 # Editing Object
487 # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
488 # for more information.
489 &quot;uriPrefix&quot;: &quot;A String&quot;, # The uri prefix of all generated Cloud Storage objects. For example:
490 # &quot;gs://bucket_name/object_name_prefix&quot;. Each object uri is in format:
491 # &quot;gs://bucket_name/object_name_prefix/&lt;asset type&gt;/&lt;shard number&gt; and only
492 # contains assets for that type. &lt;shard number&gt; starts from 0. For example:
493 # &quot;gs://bucket_name/object_name_prefix/google.compute.disk/0&quot; 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 # &quot;gs://bucket_name/object_name_prefix&quot; already exists.
497 },
498 },
499 &quot;assetTypes&quot;: [ # A list of asset types of which to take a snapshot for. For example:
500 # &quot;google.compute.Disk&quot;. 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 &quot;A String&quot;,
505 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700506 }
507
508 x__xgafv: string, V1 error format.
509 Allowed values
510 1 - v1 error format
511 2 - v2 error format
512
513Returns:
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 Kim65020912020-05-20 12:08:20 -0700518 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700519 # 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 Kim65020912020-05-20 12:08:20 -0700526 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700527 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700528 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700529 # originally returns it. If you use the default HTTP mapping, the
Dan O'Mearadd494642020-05-01 07:42:23 -0700530 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700531 &quot;error&quot;: { # 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 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
539 # message types for APIs to use.
540 {
541 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
542 },
543 ],
544 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
545 &quot;message&quot;: &quot;A String&quot;, # 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 &quot;metadata&quot;: { # 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 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
554 },
555 &quot;done&quot;: 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 Kim715bd7f2019-06-14 16:50:42 -0700558 }</pre>
559</div>
560
561</body></html>