blob: 5e0d97b3ee6eef4ea9b0584215f7d39f6c060acc [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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_v1.html">Cloud Asset API</a> . <a href="cloudasset_v1.feeds.html">feeds</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a feed in a parent project/folder/organization to listen to its</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an asset feed.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets details about an asset feed.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists all asset feeds in a parent project/folder/organization.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Updates an asset feed configuration.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
95 <pre>Creates a feed in a parent project/folder/organization to listen to its
96asset updates.
97
98Args:
99 parent: string, Required. The name of the project/folder/organization where this feed
100should be created in. It can only be an organization number (such as
101&quot;organizations/123&quot;), a folder number (such as &quot;folders/123&quot;), a project ID
102(such as &quot;projects/my-project-id&quot;)&quot;, or a project number (such as
103&quot;projects/12345&quot;). (required)
104 body: object, The request body.
105 The object takes the form of:
106
107{ # Create asset feed request.
108 &quot;feedId&quot;: &quot;A String&quot;, # Required. This is the client-assigned asset feed identifier and it needs to
109 # be unique under a specific parent project/folder/organization.
110 &quot;feed&quot;: { # An asset feed used to export asset updates to a destinations. # Required. The feed details. The field `name` must be empty and it will be generated
111 # in the format of:
112 # projects/project_number/feeds/feed_id
113 # folders/folder_number/feeds/feed_id
114 # organizations/organization_number/feeds/feed_id
115 # An asset feed filter controls what updates are exported.
116 # The asset feed must be created within a project, organization, or
117 # folder. Supported destinations are:
118 # Pub/Sub topics.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700119 &quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
120 # or both of asset_names and asset_types. Only asset updates matching
121 # specified asset_names or asset_types are exported to the feed.
122 # Example: `&quot;compute.googleapis.com/Disk&quot;`
123 #
124 # See [this
125 # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
126 # for a list of all supported asset types.
127 &quot;A String&quot;,
128 ],
129 &quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
130 # published to.
131 &quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
132 &quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
133 # Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
134 },
135 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700136 &quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
137 # either or both of asset_names and asset_types. Only asset updates matching
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700138 # specified asset_names or asset_types are exported to the feed.
139 # Example:
Bu Sun Kim65020912020-05-20 12:08:20 -0700140 # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
141 # See [Resource
142 # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
143 # for more info.
144 &quot;A String&quot;,
145 ],
146 &quot;name&quot;: &quot;A String&quot;, # Required. The format will be
147 # projects/{project_number}/feeds/{client-assigned_feed_identifier} or
148 # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
149 # organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
150 #
151 # The client-assigned feed identifier must be unique within the parent
152 # project/folder/organization.
153 &quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
154 # type will be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 },
156 }
157
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
166 { # An asset feed used to export asset updates to a destinations.
167 # An asset feed filter controls what updates are exported.
168 # The asset feed must be created within a project, organization, or
169 # folder. Supported destinations are:
170 # Pub/Sub topics.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700171 &quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
172 # or both of asset_names and asset_types. Only asset updates matching
173 # specified asset_names or asset_types are exported to the feed.
174 # Example: `&quot;compute.googleapis.com/Disk&quot;`
175 #
176 # See [this
177 # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
178 # for a list of all supported asset types.
179 &quot;A String&quot;,
180 ],
181 &quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
182 # published to.
183 &quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
184 &quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
185 # Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
186 },
187 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700188 &quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
189 # either or both of asset_names and asset_types. Only asset updates matching
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700190 # specified asset_names or asset_types are exported to the feed.
191 # Example:
Bu Sun Kim65020912020-05-20 12:08:20 -0700192 # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
193 # See [Resource
194 # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
195 # for more info.
196 &quot;A String&quot;,
197 ],
198 &quot;name&quot;: &quot;A String&quot;, # Required. The format will be
199 # projects/{project_number}/feeds/{client-assigned_feed_identifier} or
200 # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
201 # organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
202 #
203 # The client-assigned feed identifier must be unique within the parent
204 # project/folder/organization.
205 &quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
206 # type will be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700207 }</pre>
208</div>
209
210<div class="method">
211 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
212 <pre>Deletes an asset feed.
213
214Args:
215 name: string, Required. The name of the feed and it must be in the format of:
216projects/project_number/feeds/feed_id
217folders/folder_number/feeds/feed_id
218organizations/organization_number/feeds/feed_id (required)
219 x__xgafv: string, V1 error format.
220 Allowed values
221 1 - v1 error format
222 2 - v2 error format
223
224Returns:
225 An object of the form:
226
227 { # A generic empty message that you can re-use to avoid defining duplicated
228 # empty messages in your APIs. A typical example is to use it as the request
229 # or the response type of an API method. For instance:
230 #
231 # service Foo {
232 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
233 # }
234 #
235 # The JSON representation for `Empty` is empty JSON object `{}`.
236 }</pre>
237</div>
238
239<div class="method">
240 <code class="details" id="get">get(name, x__xgafv=None)</code>
241 <pre>Gets details about an asset feed.
242
243Args:
244 name: string, Required. The name of the Feed and it must be in the format of:
245projects/project_number/feeds/feed_id
246folders/folder_number/feeds/feed_id
247organizations/organization_number/feeds/feed_id (required)
248 x__xgafv: string, V1 error format.
249 Allowed values
250 1 - v1 error format
251 2 - v2 error format
252
253Returns:
254 An object of the form:
255
256 { # An asset feed used to export asset updates to a destinations.
257 # An asset feed filter controls what updates are exported.
258 # The asset feed must be created within a project, organization, or
259 # folder. Supported destinations are:
260 # Pub/Sub topics.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700261 &quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
262 # or both of asset_names and asset_types. Only asset updates matching
263 # specified asset_names or asset_types are exported to the feed.
264 # Example: `&quot;compute.googleapis.com/Disk&quot;`
265 #
266 # See [this
267 # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
268 # for a list of all supported asset types.
269 &quot;A String&quot;,
270 ],
271 &quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
272 # published to.
273 &quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
274 &quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
275 # Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
276 },
277 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700278 &quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
279 # either or both of asset_names and asset_types. Only asset updates matching
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700280 # specified asset_names or asset_types are exported to the feed.
281 # Example:
Bu Sun Kim65020912020-05-20 12:08:20 -0700282 # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
283 # See [Resource
284 # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
285 # for more info.
286 &quot;A String&quot;,
287 ],
288 &quot;name&quot;: &quot;A String&quot;, # Required. The format will be
289 # projects/{project_number}/feeds/{client-assigned_feed_identifier} or
290 # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
291 # organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
292 #
293 # The client-assigned feed identifier must be unique within the parent
294 # project/folder/organization.
295 &quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
296 # type will be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700297 }</pre>
298</div>
299
300<div class="method">
301 <code class="details" id="list">list(parent, x__xgafv=None)</code>
302 <pre>Lists all asset feeds in a parent project/folder/organization.
303
304Args:
305 parent: string, Required. The parent project/folder/organization whose feeds are to be
306listed. It can only be using project/folder/organization number (such as
307&quot;folders/12345&quot;)&quot;, or a project ID (such as &quot;projects/my-project-id&quot;). (required)
308 x__xgafv: string, V1 error format.
309 Allowed values
310 1 - v1 error format
311 2 - v2 error format
312
313Returns:
314 An object of the form:
315
316 {
317 &quot;feeds&quot;: [ # A list of feeds.
318 { # An asset feed used to export asset updates to a destinations.
319 # An asset feed filter controls what updates are exported.
320 # The asset feed must be created within a project, organization, or
321 # folder. Supported destinations are:
322 # Pub/Sub topics.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700323 &quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
324 # or both of asset_names and asset_types. Only asset updates matching
325 # specified asset_names or asset_types are exported to the feed.
326 # Example: `&quot;compute.googleapis.com/Disk&quot;`
327 #
328 # See [this
329 # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
330 # for a list of all supported asset types.
331 &quot;A String&quot;,
332 ],
333 &quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
334 # published to.
335 &quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
336 &quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
337 # Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
338 },
339 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700340 &quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
341 # either or both of asset_names and asset_types. Only asset updates matching
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700342 # specified asset_names or asset_types are exported to the feed.
343 # Example:
Bu Sun Kim65020912020-05-20 12:08:20 -0700344 # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
345 # See [Resource
346 # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
347 # for more info.
348 &quot;A String&quot;,
349 ],
350 &quot;name&quot;: &quot;A String&quot;, # Required. The format will be
351 # projects/{project_number}/feeds/{client-assigned_feed_identifier} or
352 # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
353 # organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
354 #
355 # The client-assigned feed identifier must be unique within the parent
356 # project/folder/organization.
357 &quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
358 # type will be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700359 },
360 ],
361 }</pre>
362</div>
363
364<div class="method">
365 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
366 <pre>Updates an asset feed configuration.
367
368Args:
369 name: string, Required. The format will be
370projects/{project_number}/feeds/{client-assigned_feed_identifier} or
371folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
372organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
373
374The client-assigned feed identifier must be unique within the parent
375project/folder/organization. (required)
376 body: object, The request body.
377 The object takes the form of:
378
379{ # Update asset feed request.
380 &quot;updateMask&quot;: &quot;A String&quot;, # Required. Only updates the `feed` fields indicated by this mask.
381 # The field mask must not be empty, and it must not contain fields that
382 # are immutable or only set by the server.
383 &quot;feed&quot;: { # An asset feed used to export asset updates to a destinations. # Required. The new values of feed details. It must match an existing feed and the
384 # field `name` must be in the format of:
385 # projects/project_number/feeds/feed_id or
386 # folders/folder_number/feeds/feed_id or
387 # organizations/organization_number/feeds/feed_id.
388 # An asset feed filter controls what updates are exported.
389 # The asset feed must be created within a project, organization, or
390 # folder. Supported destinations are:
391 # Pub/Sub topics.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700392 &quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
393 # or both of asset_names and asset_types. Only asset updates matching
394 # specified asset_names or asset_types are exported to the feed.
395 # Example: `&quot;compute.googleapis.com/Disk&quot;`
396 #
397 # See [this
398 # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
399 # for a list of all supported asset types.
400 &quot;A String&quot;,
401 ],
402 &quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
403 # published to.
404 &quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
405 &quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
406 # Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
407 },
408 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700409 &quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
410 # either or both of asset_names and asset_types. Only asset updates matching
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700411 # specified asset_names or asset_types are exported to the feed.
412 # Example:
Bu Sun Kim65020912020-05-20 12:08:20 -0700413 # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
414 # See [Resource
415 # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
416 # for more info.
417 &quot;A String&quot;,
418 ],
419 &quot;name&quot;: &quot;A String&quot;, # Required. The format will be
420 # projects/{project_number}/feeds/{client-assigned_feed_identifier} or
421 # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
422 # organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
423 #
424 # The client-assigned feed identifier must be unique within the parent
425 # project/folder/organization.
426 &quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
427 # type will be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700428 },
429 }
430
431 x__xgafv: string, V1 error format.
432 Allowed values
433 1 - v1 error format
434 2 - v2 error format
435
436Returns:
437 An object of the form:
438
439 { # An asset feed used to export asset updates to a destinations.
440 # An asset feed filter controls what updates are exported.
441 # The asset feed must be created within a project, organization, or
442 # folder. Supported destinations are:
443 # Pub/Sub topics.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700444 &quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
445 # or both of asset_names and asset_types. Only asset updates matching
446 # specified asset_names or asset_types are exported to the feed.
447 # Example: `&quot;compute.googleapis.com/Disk&quot;`
448 #
449 # See [this
450 # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
451 # for a list of all supported asset types.
452 &quot;A String&quot;,
453 ],
454 &quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
455 # published to.
456 &quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
457 &quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
458 # Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
459 },
460 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700461 &quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
462 # either or both of asset_names and asset_types. Only asset updates matching
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700463 # specified asset_names or asset_types are exported to the feed.
464 # Example:
Bu Sun Kim65020912020-05-20 12:08:20 -0700465 # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
466 # See [Resource
467 # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
468 # for more info.
469 &quot;A String&quot;,
470 ],
471 &quot;name&quot;: &quot;A String&quot;, # Required. The format will be
472 # projects/{project_number}/feeds/{client-assigned_feed_identifier} or
473 # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
474 # organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
475 #
476 # The client-assigned feed identifier must be unique within the parent
477 # project/folder/organization.
478 &quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
479 # type will be returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700480 }</pre>
481</div>
482
483</body></html>