Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / cloudasset_v1beta1.folders.html
blob: 9e34812e28d0c34f25fe0daebbbc1bc9b5cac01e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudasset_v1beta1.html">Cloud Asset API</a> . <a href="cloudasset_v1beta1.folders.html">folders</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudasset_v1beta1.folders.operations.html">operations()</a></code>
79</p>
80<p class="firstline">Returns the operations Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#exportAssets">exportAssets(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Exports assets with time and resource types to a given Cloud Storage</p>
85<h3>Method Details</h3>
86<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code class="details" id="exportAssets">exportAssets(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88 <pre>Exports assets with time and resource types to a given Cloud Storage
89location. The output format is newline-delimited JSON.
90This API implements the google.longrunning.Operation API allowing you
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]91to keep track of the export. We recommend intervals of at least 2 seconds
92with exponential retry to poll the export operation result. For
93regular-size resource parent, the export operation usually finishes within
945 minutes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95
96Args:
97 parent: string, Required. The relative name of the root asset. This can only be an
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98organization number (such as &quot;organizations/123&quot;), a project ID (such as
99&quot;projects/my-project-id&quot;), a project number (such as &quot;projects/12345&quot;), or
100a folder number (such as &quot;folders/123&quot;). (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102 The object takes the form of:
103
104{ # Export asset request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]105 &quot;assetTypes&quot;: [ # A list of asset types of which to take a snapshot for. For example:
106 # &quot;google.compute.Disk&quot;. If specified, only matching assets will be returned.
107 # See [Introduction to Cloud Asset
108 # Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
109 # for all supported asset types.
110 &quot;A String&quot;,
111 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &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 -0700[diff] [blame]113 # between 2018-10-02 UTC (inclusive) and the current time. If not specified,
114 # the current time will be used. Due to delays in resource data collection
115 # and indexing, there is a volatile window during which running the same
116 # query may get different results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name will be
118 # returned.
119 &quot;outputConfig&quot;: { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output
120 # to. All results will be in newline delimited JSON format.
121 &quot;gcsDestination&quot;: { # A Cloud Storage location. # Destination on Cloud Storage.
122 &quot;uri&quot;: &quot;A String&quot;, # The uri of the Cloud Storage object. It&#x27;s the same uri that is used by
123 # gsutil. For example: &quot;gs://bucket_name/object_name&quot;. See [Viewing and
124 # Editing Object
125 # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
126 # for more information.
127 &quot;uriPrefix&quot;: &quot;A String&quot;, # The uri prefix of all generated Cloud Storage objects. For example:
128 # &quot;gs://bucket_name/object_name_prefix&quot;. Each object uri is in format:
129 # &quot;gs://bucket_name/object_name_prefix/&lt;asset type&gt;/&lt;shard number&gt; and only
130 # contains assets for that type. &lt;shard number&gt; starts from 0. For example:
131 # &quot;gs://bucket_name/object_name_prefix/google.compute.disk/0&quot; is the first
132 # shard of output objects containing all google.compute.disk assets.
133 # An INVALID_ARGUMENT error will be returned if file with the same name
134 # &quot;gs://bucket_name/object_name_prefix&quot; already exists.
135 },
136 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 }
138
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 { # This resource represents a long-running operation that is the result of a
148 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]149 &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.
150 # different programming environments, including REST APIs and RPC APIs. It is
151 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
152 # three pieces of data: error code, error message, and error details.
153 #
154 # You can find out more about this error model and how to work with it in the
155 # [API Design Guide](https://cloud.google.com/apis/design/errors).
156 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
157 # user-facing error message should be localized and sent in the
158 # google.rpc.Status.details field, or localized by the client.
159 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
160 # message types for APIs to use.
161 {
162 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
163 },
164 ],
165 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
166 },
167 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
168 # contains progress information and common metadata such as create time.
169 # Some services might not provide such metadata. Any method that returns a
170 # long-running operation should document the metadata type, if any.
171 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
172 },
173 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
174 # If `true`, the operation is completed, and either `error` or `response` is
175 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 # method returns no data on success, such as `Delete`, the response is
178 # `google.protobuf.Empty`. If the original method is standard
179 # `Get`/`Create`/`Update`, the response should be the resource. For other
180 # methods, the response should have the type `XxxResponse`, where `Xxx`
181 # is the original method name. For example, if the original method name
182 # is `TakeSnapshot()`, the inferred response type is
183 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]185 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 &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 -0700[diff] [blame]187 # originally returns it. If you use the default HTTP mapping, the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]188 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 }</pre>
190</div>
191
192</body></html>