| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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_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 |
| 96 | asset updates. |
| 97 | |
| 98 | Args: |
| 99 | parent: string, Required. The name of the project/folder/organization where this feed |
| 100 | should be created in. It can only be an organization number (such as |
| 101 | "organizations/123"), a folder number (such as "folders/123"), a project ID |
| 102 | (such as "projects/my-project-id")", or a project number (such as |
| 103 | "projects/12345"). (required) |
| 104 | body: object, The request body. |
| 105 | The object takes the form of: |
| 106 | |
| 107 | { # Create asset feed request. |
| 108 | "feedId": "A String", # Required. This is the client-assigned asset feed identifier and it needs to |
| 109 | # be unique under a specific parent project/folder/organization. |
| 110 | "feed": { # 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. |
| 119 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 120 | # either or both of asset_names and asset_types. Only asset updates matching |
| 121 | # specified asset_names and asset_types are exported to the feed. For |
| 122 | # example: |
| 123 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 124 | # See [Resource |
| 125 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 126 | # for more info. |
| 127 | "A String", |
| 128 | ], |
| 129 | "name": "A String", # Required. The format will be |
| 130 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 131 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 132 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 133 | # |
| 134 | # The client-assigned feed identifier must be unique within the parent |
| 135 | # project/folder/organization. |
| 136 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 137 | # type will be returned. |
| 138 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 139 | # or both of asset_names and asset_types. Only asset updates matching |
| 140 | # specified asset_names and asset_types are exported to the feed. |
| 141 | # For example: `"compute.googleapis.com/Disk"` |
| 142 | # |
| 143 | # See [this |
| 144 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 145 | # for a list of all supported asset types. |
| 146 | "A String", |
| 147 | ], |
| 148 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 149 | # published to. |
| 150 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 151 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 152 | # For example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 153 | }, |
| 154 | }, |
| 155 | }, |
| 156 | } |
| 157 | |
| 158 | x__xgafv: string, V1 error format. |
| 159 | Allowed values |
| 160 | 1 - v1 error format |
| 161 | 2 - v2 error format |
| 162 | |
| 163 | Returns: |
| 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. |
| 171 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 172 | # either or both of asset_names and asset_types. Only asset updates matching |
| 173 | # specified asset_names and asset_types are exported to the feed. For |
| 174 | # example: |
| 175 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 176 | # See [Resource |
| 177 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 178 | # for more info. |
| 179 | "A String", |
| 180 | ], |
| 181 | "name": "A String", # Required. The format will be |
| 182 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 183 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 184 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 185 | # |
| 186 | # The client-assigned feed identifier must be unique within the parent |
| 187 | # project/folder/organization. |
| 188 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 189 | # type will be returned. |
| 190 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 191 | # or both of asset_names and asset_types. Only asset updates matching |
| 192 | # specified asset_names and asset_types are exported to the feed. |
| 193 | # For example: `"compute.googleapis.com/Disk"` |
| 194 | # |
| 195 | # See [this |
| 196 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 197 | # for a list of all supported asset types. |
| 198 | "A String", |
| 199 | ], |
| 200 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 201 | # published to. |
| 202 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 203 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 204 | # For example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 205 | }, |
| 206 | }, |
| 207 | }</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 | |
| 214 | Args: |
| 215 | name: string, Required. The name of the feed and it must be in the format of: |
| 216 | projects/project_number/feeds/feed_id |
| 217 | folders/folder_number/feeds/feed_id |
| 218 | organizations/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 | |
| 224 | Returns: |
| 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 | |
| 243 | Args: |
| 244 | name: string, Required. The name of the Feed and it must be in the format of: |
| 245 | projects/project_number/feeds/feed_id |
| 246 | folders/folder_number/feeds/feed_id |
| 247 | organizations/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 | |
| 253 | Returns: |
| 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. |
| 261 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 262 | # either or both of asset_names and asset_types. Only asset updates matching |
| 263 | # specified asset_names and asset_types are exported to the feed. For |
| 264 | # example: |
| 265 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 266 | # See [Resource |
| 267 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 268 | # for more info. |
| 269 | "A String", |
| 270 | ], |
| 271 | "name": "A String", # Required. The format will be |
| 272 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 273 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 274 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 275 | # |
| 276 | # The client-assigned feed identifier must be unique within the parent |
| 277 | # project/folder/organization. |
| 278 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 279 | # type will be returned. |
| 280 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 281 | # or both of asset_names and asset_types. Only asset updates matching |
| 282 | # specified asset_names and asset_types are exported to the feed. |
| 283 | # For example: `"compute.googleapis.com/Disk"` |
| 284 | # |
| 285 | # See [this |
| 286 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 287 | # for a list of all supported asset types. |
| 288 | "A String", |
| 289 | ], |
| 290 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 291 | # published to. |
| 292 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 293 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 294 | # For example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 295 | }, |
| 296 | }, |
| 297 | }</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 | |
| 304 | Args: |
| 305 | parent: string, Required. The parent project/folder/organization whose feeds are to be |
| 306 | listed. It can only be using project/folder/organization number (such as |
| 307 | "folders/12345")", or a project ID (such as "projects/my-project-id"). (required) |
| 308 | x__xgafv: string, V1 error format. |
| 309 | Allowed values |
| 310 | 1 - v1 error format |
| 311 | 2 - v2 error format |
| 312 | |
| 313 | Returns: |
| 314 | An object of the form: |
| 315 | |
| 316 | { |
| 317 | "feeds": [ # 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. |
| 323 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 324 | # either or both of asset_names and asset_types. Only asset updates matching |
| 325 | # specified asset_names and asset_types are exported to the feed. For |
| 326 | # example: |
| 327 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 328 | # See [Resource |
| 329 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 330 | # for more info. |
| 331 | "A String", |
| 332 | ], |
| 333 | "name": "A String", # Required. The format will be |
| 334 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 335 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 336 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 337 | # |
| 338 | # The client-assigned feed identifier must be unique within the parent |
| 339 | # project/folder/organization. |
| 340 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 341 | # type will be returned. |
| 342 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 343 | # or both of asset_names and asset_types. Only asset updates matching |
| 344 | # specified asset_names and asset_types are exported to the feed. |
| 345 | # For example: `"compute.googleapis.com/Disk"` |
| 346 | # |
| 347 | # See [this |
| 348 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 349 | # for a list of all supported asset types. |
| 350 | "A String", |
| 351 | ], |
| 352 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 353 | # published to. |
| 354 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 355 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 356 | # For example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 357 | }, |
| 358 | }, |
| 359 | }, |
| 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 | |
| 368 | Args: |
| 369 | name: string, Required. The format will be |
| 370 | projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 371 | folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 372 | organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 373 | |
| 374 | The client-assigned feed identifier must be unique within the parent |
| 375 | project/folder/organization. (required) |
| 376 | body: object, The request body. |
| 377 | The object takes the form of: |
| 378 | |
| 379 | { # Update asset feed request. |
| 380 | "updateMask": "A String", # 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 | "feed": { # 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. |
| 392 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 393 | # either or both of asset_names and asset_types. Only asset updates matching |
| 394 | # specified asset_names and asset_types are exported to the feed. For |
| 395 | # example: |
| 396 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 397 | # See [Resource |
| 398 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 399 | # for more info. |
| 400 | "A String", |
| 401 | ], |
| 402 | "name": "A String", # Required. The format will be |
| 403 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 404 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 405 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 406 | # |
| 407 | # The client-assigned feed identifier must be unique within the parent |
| 408 | # project/folder/organization. |
| 409 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 410 | # type will be returned. |
| 411 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 412 | # or both of asset_names and asset_types. Only asset updates matching |
| 413 | # specified asset_names and asset_types are exported to the feed. |
| 414 | # For example: `"compute.googleapis.com/Disk"` |
| 415 | # |
| 416 | # See [this |
| 417 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 418 | # for a list of all supported asset types. |
| 419 | "A String", |
| 420 | ], |
| 421 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 422 | # published to. |
| 423 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 424 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 425 | # For example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 426 | }, |
| 427 | }, |
| 428 | }, |
| 429 | } |
| 430 | |
| 431 | x__xgafv: string, V1 error format. |
| 432 | Allowed values |
| 433 | 1 - v1 error format |
| 434 | 2 - v2 error format |
| 435 | |
| 436 | Returns: |
| 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. |
| 444 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 445 | # either or both of asset_names and asset_types. Only asset updates matching |
| 446 | # specified asset_names and asset_types are exported to the feed. For |
| 447 | # example: |
| 448 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 449 | # See [Resource |
| 450 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 451 | # for more info. |
| 452 | "A String", |
| 453 | ], |
| 454 | "name": "A String", # Required. The format will be |
| 455 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 456 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 457 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 458 | # |
| 459 | # The client-assigned feed identifier must be unique within the parent |
| 460 | # project/folder/organization. |
| 461 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 462 | # type will be returned. |
| 463 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 464 | # or both of asset_names and asset_types. Only asset updates matching |
| 465 | # specified asset_names and asset_types are exported to the feed. |
| 466 | # For example: `"compute.googleapis.com/Disk"` |
| 467 | # |
| 468 | # See [this |
| 469 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 470 | # for a list of all supported asset types. |
| 471 | "A String", |
| 472 | ], |
| 473 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 474 | # published to. |
| 475 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 476 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 477 | # For example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 478 | }, |
| 479 | }, |
| 480 | }</pre> |
| 481 | </div> |
| 482 | |
| 483 | </body></html> |