| 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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 119 | "name": "A String", # Required. The format will be |
| 120 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 121 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 122 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 123 | # |
| 124 | # The client-assigned feed identifier must be unique within the parent |
| 125 | # project/folder/organization. |
| 126 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 127 | # type will be returned. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 128 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 129 | # or both of asset_names and asset_types. Only asset updates matching |
| 130 | # specified asset_names or asset_types are exported to the feed. |
| 131 | # Example: `"compute.googleapis.com/Disk"` |
| 132 | # |
| 133 | # See [this |
| 134 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 135 | # for a list of all supported asset types. |
| 136 | "A String", |
| 137 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 138 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 139 | # either or both of asset_names and asset_types. Only asset updates matching |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 140 | # specified asset_names or asset_types are exported to the feed. |
| 141 | # Example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 143 | # See [Resource |
| 144 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 145 | # for more info. |
| 146 | "A String", |
| 147 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 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 | # Example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 153 | }, |
| 154 | }, |
| 155 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition which determines whether an asset update should be published. |
| 156 | # If specified, an asset will be returned only when the expression evaluates |
| 157 | # to true. |
| 158 | # When set, `expression` field in the `Expr` must be a valid [CEL expression] |
| 159 | # (https://github.com/google/cel-spec) on a TemporalAsset with name |
| 160 | # `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted |
| 161 | # == true") will only publish Asset deletions. Other fields of `Expr` are |
| 162 | # optional. |
| 163 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 164 | # are documented at https://github.com/google/cel-spec. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 166 | # Example (Comparison): |
| 167 | # |
| 168 | # title: "Summary size limit" |
| 169 | # description: "Determines if a summary is less than 100 chars" |
| 170 | # expression: "document.summary.size() < 100" |
| 171 | # |
| 172 | # Example (Equality): |
| 173 | # |
| 174 | # title: "Requestor is owner" |
| 175 | # description: "Determines if requestor is the document owner" |
| 176 | # expression: "document.owner == request.auth.claims.email" |
| 177 | # |
| 178 | # Example (Logic): |
| 179 | # |
| 180 | # title: "Public documents" |
| 181 | # description: "Determine whether the document should be publicly visible" |
| 182 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 183 | # |
| 184 | # Example (Data Manipulation): |
| 185 | # |
| 186 | # title: "Notification string" |
| 187 | # description: "Create a notification string with a timestamp." |
| 188 | # expression: "'New message received at ' + string(document.create_time)" |
| 189 | # |
| 190 | # The exact variables and functions that may be referenced within an expression |
| 191 | # are determined by the service that evaluates it. See the service |
| 192 | # documentation for additional information. |
| 193 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 194 | # describes the expression, e.g. when hovered over it in a UI. |
| 195 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 196 | # reporting, e.g. a file name and a position in the file. |
| 197 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 198 | # syntax. |
| 199 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 200 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 201 | # expression. |
| 202 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 203 | }, |
| 204 | } |
| 205 | |
| 206 | x__xgafv: string, V1 error format. |
| 207 | Allowed values |
| 208 | 1 - v1 error format |
| 209 | 2 - v2 error format |
| 210 | |
| 211 | Returns: |
| 212 | An object of the form: |
| 213 | |
| 214 | { # An asset feed used to export asset updates to a destinations. |
| 215 | # An asset feed filter controls what updates are exported. |
| 216 | # The asset feed must be created within a project, organization, or |
| 217 | # folder. Supported destinations are: |
| 218 | # Pub/Sub topics. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 219 | "name": "A String", # Required. The format will be |
| 220 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 221 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 222 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 223 | # |
| 224 | # The client-assigned feed identifier must be unique within the parent |
| 225 | # project/folder/organization. |
| 226 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 227 | # type will be returned. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 228 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 229 | # or both of asset_names and asset_types. Only asset updates matching |
| 230 | # specified asset_names or asset_types are exported to the feed. |
| 231 | # Example: `"compute.googleapis.com/Disk"` |
| 232 | # |
| 233 | # See [this |
| 234 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 235 | # for a list of all supported asset types. |
| 236 | "A String", |
| 237 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 238 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 239 | # either or both of asset_names and asset_types. Only asset updates matching |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 240 | # specified asset_names or asset_types are exported to the feed. |
| 241 | # Example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 242 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 243 | # See [Resource |
| 244 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 245 | # for more info. |
| 246 | "A String", |
| 247 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 248 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 249 | # published to. |
| 250 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 251 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 252 | # Example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 253 | }, |
| 254 | }, |
| 255 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition which determines whether an asset update should be published. |
| 256 | # If specified, an asset will be returned only when the expression evaluates |
| 257 | # to true. |
| 258 | # When set, `expression` field in the `Expr` must be a valid [CEL expression] |
| 259 | # (https://github.com/google/cel-spec) on a TemporalAsset with name |
| 260 | # `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted |
| 261 | # == true") will only publish Asset deletions. Other fields of `Expr` are |
| 262 | # optional. |
| 263 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 264 | # are documented at https://github.com/google/cel-spec. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 265 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 266 | # Example (Comparison): |
| 267 | # |
| 268 | # title: "Summary size limit" |
| 269 | # description: "Determines if a summary is less than 100 chars" |
| 270 | # expression: "document.summary.size() < 100" |
| 271 | # |
| 272 | # Example (Equality): |
| 273 | # |
| 274 | # title: "Requestor is owner" |
| 275 | # description: "Determines if requestor is the document owner" |
| 276 | # expression: "document.owner == request.auth.claims.email" |
| 277 | # |
| 278 | # Example (Logic): |
| 279 | # |
| 280 | # title: "Public documents" |
| 281 | # description: "Determine whether the document should be publicly visible" |
| 282 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 283 | # |
| 284 | # Example (Data Manipulation): |
| 285 | # |
| 286 | # title: "Notification string" |
| 287 | # description: "Create a notification string with a timestamp." |
| 288 | # expression: "'New message received at ' + string(document.create_time)" |
| 289 | # |
| 290 | # The exact variables and functions that may be referenced within an expression |
| 291 | # are determined by the service that evaluates it. See the service |
| 292 | # documentation for additional information. |
| 293 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 294 | # describes the expression, e.g. when hovered over it in a UI. |
| 295 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 296 | # reporting, e.g. a file name and a position in the file. |
| 297 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 298 | # syntax. |
| 299 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 300 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 301 | # expression. |
| 302 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 303 | }</pre> |
| 304 | </div> |
| 305 | |
| 306 | <div class="method"> |
| 307 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 308 | <pre>Deletes an asset feed. |
| 309 | |
| 310 | Args: |
| 311 | name: string, Required. The name of the feed and it must be in the format of: |
| 312 | projects/project_number/feeds/feed_id |
| 313 | folders/folder_number/feeds/feed_id |
| 314 | organizations/organization_number/feeds/feed_id (required) |
| 315 | x__xgafv: string, V1 error format. |
| 316 | Allowed values |
| 317 | 1 - v1 error format |
| 318 | 2 - v2 error format |
| 319 | |
| 320 | Returns: |
| 321 | An object of the form: |
| 322 | |
| 323 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 324 | # empty messages in your APIs. A typical example is to use it as the request |
| 325 | # or the response type of an API method. For instance: |
| 326 | # |
| 327 | # service Foo { |
| 328 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 329 | # } |
| 330 | # |
| 331 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 332 | }</pre> |
| 333 | </div> |
| 334 | |
| 335 | <div class="method"> |
| 336 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 337 | <pre>Gets details about an asset feed. |
| 338 | |
| 339 | Args: |
| 340 | name: string, Required. The name of the Feed and it must be in the format of: |
| 341 | projects/project_number/feeds/feed_id |
| 342 | folders/folder_number/feeds/feed_id |
| 343 | organizations/organization_number/feeds/feed_id (required) |
| 344 | x__xgafv: string, V1 error format. |
| 345 | Allowed values |
| 346 | 1 - v1 error format |
| 347 | 2 - v2 error format |
| 348 | |
| 349 | Returns: |
| 350 | An object of the form: |
| 351 | |
| 352 | { # An asset feed used to export asset updates to a destinations. |
| 353 | # An asset feed filter controls what updates are exported. |
| 354 | # The asset feed must be created within a project, organization, or |
| 355 | # folder. Supported destinations are: |
| 356 | # Pub/Sub topics. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 357 | "name": "A String", # Required. The format will be |
| 358 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 359 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 360 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 361 | # |
| 362 | # The client-assigned feed identifier must be unique within the parent |
| 363 | # project/folder/organization. |
| 364 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 365 | # type will be returned. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 366 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 367 | # or both of asset_names and asset_types. Only asset updates matching |
| 368 | # specified asset_names or asset_types are exported to the feed. |
| 369 | # Example: `"compute.googleapis.com/Disk"` |
| 370 | # |
| 371 | # See [this |
| 372 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 373 | # for a list of all supported asset types. |
| 374 | "A String", |
| 375 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 377 | # either or both of asset_names and asset_types. Only asset updates matching |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 378 | # specified asset_names or asset_types are exported to the feed. |
| 379 | # Example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 380 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 381 | # See [Resource |
| 382 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 383 | # for more info. |
| 384 | "A String", |
| 385 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 386 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 387 | # published to. |
| 388 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 389 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 390 | # Example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 391 | }, |
| 392 | }, |
| 393 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition which determines whether an asset update should be published. |
| 394 | # If specified, an asset will be returned only when the expression evaluates |
| 395 | # to true. |
| 396 | # When set, `expression` field in the `Expr` must be a valid [CEL expression] |
| 397 | # (https://github.com/google/cel-spec) on a TemporalAsset with name |
| 398 | # `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted |
| 399 | # == true") will only publish Asset deletions. Other fields of `Expr` are |
| 400 | # optional. |
| 401 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 402 | # are documented at https://github.com/google/cel-spec. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 403 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 404 | # Example (Comparison): |
| 405 | # |
| 406 | # title: "Summary size limit" |
| 407 | # description: "Determines if a summary is less than 100 chars" |
| 408 | # expression: "document.summary.size() < 100" |
| 409 | # |
| 410 | # Example (Equality): |
| 411 | # |
| 412 | # title: "Requestor is owner" |
| 413 | # description: "Determines if requestor is the document owner" |
| 414 | # expression: "document.owner == request.auth.claims.email" |
| 415 | # |
| 416 | # Example (Logic): |
| 417 | # |
| 418 | # title: "Public documents" |
| 419 | # description: "Determine whether the document should be publicly visible" |
| 420 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 421 | # |
| 422 | # Example (Data Manipulation): |
| 423 | # |
| 424 | # title: "Notification string" |
| 425 | # description: "Create a notification string with a timestamp." |
| 426 | # expression: "'New message received at ' + string(document.create_time)" |
| 427 | # |
| 428 | # The exact variables and functions that may be referenced within an expression |
| 429 | # are determined by the service that evaluates it. See the service |
| 430 | # documentation for additional information. |
| 431 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 432 | # describes the expression, e.g. when hovered over it in a UI. |
| 433 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 434 | # reporting, e.g. a file name and a position in the file. |
| 435 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 436 | # syntax. |
| 437 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 438 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 439 | # expression. |
| 440 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 441 | }</pre> |
| 442 | </div> |
| 443 | |
| 444 | <div class="method"> |
| 445 | <code class="details" id="list">list(parent, x__xgafv=None)</code> |
| 446 | <pre>Lists all asset feeds in a parent project/folder/organization. |
| 447 | |
| 448 | Args: |
| 449 | parent: string, Required. The parent project/folder/organization whose feeds are to be |
| 450 | listed. It can only be using project/folder/organization number (such as |
| 451 | "folders/12345")", or a project ID (such as "projects/my-project-id"). (required) |
| 452 | x__xgafv: string, V1 error format. |
| 453 | Allowed values |
| 454 | 1 - v1 error format |
| 455 | 2 - v2 error format |
| 456 | |
| 457 | Returns: |
| 458 | An object of the form: |
| 459 | |
| 460 | { |
| 461 | "feeds": [ # A list of feeds. |
| 462 | { # An asset feed used to export asset updates to a destinations. |
| 463 | # An asset feed filter controls what updates are exported. |
| 464 | # The asset feed must be created within a project, organization, or |
| 465 | # folder. Supported destinations are: |
| 466 | # Pub/Sub topics. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 467 | "name": "A String", # Required. The format will be |
| 468 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 469 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 470 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 471 | # |
| 472 | # The client-assigned feed identifier must be unique within the parent |
| 473 | # project/folder/organization. |
| 474 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 475 | # type will be returned. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 476 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 477 | # or both of asset_names and asset_types. Only asset updates matching |
| 478 | # specified asset_names or asset_types are exported to the feed. |
| 479 | # Example: `"compute.googleapis.com/Disk"` |
| 480 | # |
| 481 | # See [this |
| 482 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 483 | # for a list of all supported asset types. |
| 484 | "A String", |
| 485 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 487 | # either or both of asset_names and asset_types. Only asset updates matching |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 488 | # specified asset_names or asset_types are exported to the feed. |
| 489 | # Example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 490 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 491 | # See [Resource |
| 492 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 493 | # for more info. |
| 494 | "A String", |
| 495 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 496 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 497 | # published to. |
| 498 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 499 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 500 | # Example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 501 | }, |
| 502 | }, |
| 503 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition which determines whether an asset update should be published. |
| 504 | # If specified, an asset will be returned only when the expression evaluates |
| 505 | # to true. |
| 506 | # When set, `expression` field in the `Expr` must be a valid [CEL expression] |
| 507 | # (https://github.com/google/cel-spec) on a TemporalAsset with name |
| 508 | # `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted |
| 509 | # == true") will only publish Asset deletions. Other fields of `Expr` are |
| 510 | # optional. |
| 511 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 512 | # are documented at https://github.com/google/cel-spec. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 513 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 514 | # Example (Comparison): |
| 515 | # |
| 516 | # title: "Summary size limit" |
| 517 | # description: "Determines if a summary is less than 100 chars" |
| 518 | # expression: "document.summary.size() < 100" |
| 519 | # |
| 520 | # Example (Equality): |
| 521 | # |
| 522 | # title: "Requestor is owner" |
| 523 | # description: "Determines if requestor is the document owner" |
| 524 | # expression: "document.owner == request.auth.claims.email" |
| 525 | # |
| 526 | # Example (Logic): |
| 527 | # |
| 528 | # title: "Public documents" |
| 529 | # description: "Determine whether the document should be publicly visible" |
| 530 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 531 | # |
| 532 | # Example (Data Manipulation): |
| 533 | # |
| 534 | # title: "Notification string" |
| 535 | # description: "Create a notification string with a timestamp." |
| 536 | # expression: "'New message received at ' + string(document.create_time)" |
| 537 | # |
| 538 | # The exact variables and functions that may be referenced within an expression |
| 539 | # are determined by the service that evaluates it. See the service |
| 540 | # documentation for additional information. |
| 541 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 542 | # describes the expression, e.g. when hovered over it in a UI. |
| 543 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 544 | # reporting, e.g. a file name and a position in the file. |
| 545 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 546 | # syntax. |
| 547 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 548 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 549 | # expression. |
| 550 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 551 | }, |
| 552 | ], |
| 553 | }</pre> |
| 554 | </div> |
| 555 | |
| 556 | <div class="method"> |
| 557 | <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> |
| 558 | <pre>Updates an asset feed configuration. |
| 559 | |
| 560 | Args: |
| 561 | name: string, Required. The format will be |
| 562 | projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 563 | folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 564 | organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 565 | |
| 566 | The client-assigned feed identifier must be unique within the parent |
| 567 | project/folder/organization. (required) |
| 568 | body: object, The request body. |
| 569 | The object takes the form of: |
| 570 | |
| 571 | { # Update asset feed request. |
| 572 | "updateMask": "A String", # Required. Only updates the `feed` fields indicated by this mask. |
| 573 | # The field mask must not be empty, and it must not contain fields that |
| 574 | # are immutable or only set by the server. |
| 575 | "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 |
| 576 | # field `name` must be in the format of: |
| 577 | # projects/project_number/feeds/feed_id or |
| 578 | # folders/folder_number/feeds/feed_id or |
| 579 | # organizations/organization_number/feeds/feed_id. |
| 580 | # An asset feed filter controls what updates are exported. |
| 581 | # The asset feed must be created within a project, organization, or |
| 582 | # folder. Supported destinations are: |
| 583 | # Pub/Sub topics. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 584 | "name": "A String", # Required. The format will be |
| 585 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 586 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 587 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 588 | # |
| 589 | # The client-assigned feed identifier must be unique within the parent |
| 590 | # project/folder/organization. |
| 591 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 592 | # type will be returned. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 593 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 594 | # or both of asset_names and asset_types. Only asset updates matching |
| 595 | # specified asset_names or asset_types are exported to the feed. |
| 596 | # Example: `"compute.googleapis.com/Disk"` |
| 597 | # |
| 598 | # See [this |
| 599 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 600 | # for a list of all supported asset types. |
| 601 | "A String", |
| 602 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 603 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 604 | # either or both of asset_names and asset_types. Only asset updates matching |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 605 | # specified asset_names or asset_types are exported to the feed. |
| 606 | # Example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 607 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 608 | # See [Resource |
| 609 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 610 | # for more info. |
| 611 | "A String", |
| 612 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 613 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 614 | # published to. |
| 615 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 616 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 617 | # Example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 618 | }, |
| 619 | }, |
| 620 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition which determines whether an asset update should be published. |
| 621 | # If specified, an asset will be returned only when the expression evaluates |
| 622 | # to true. |
| 623 | # When set, `expression` field in the `Expr` must be a valid [CEL expression] |
| 624 | # (https://github.com/google/cel-spec) on a TemporalAsset with name |
| 625 | # `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted |
| 626 | # == true") will only publish Asset deletions. Other fields of `Expr` are |
| 627 | # optional. |
| 628 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 629 | # are documented at https://github.com/google/cel-spec. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 630 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 631 | # Example (Comparison): |
| 632 | # |
| 633 | # title: "Summary size limit" |
| 634 | # description: "Determines if a summary is less than 100 chars" |
| 635 | # expression: "document.summary.size() < 100" |
| 636 | # |
| 637 | # Example (Equality): |
| 638 | # |
| 639 | # title: "Requestor is owner" |
| 640 | # description: "Determines if requestor is the document owner" |
| 641 | # expression: "document.owner == request.auth.claims.email" |
| 642 | # |
| 643 | # Example (Logic): |
| 644 | # |
| 645 | # title: "Public documents" |
| 646 | # description: "Determine whether the document should be publicly visible" |
| 647 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 648 | # |
| 649 | # Example (Data Manipulation): |
| 650 | # |
| 651 | # title: "Notification string" |
| 652 | # description: "Create a notification string with a timestamp." |
| 653 | # expression: "'New message received at ' + string(document.create_time)" |
| 654 | # |
| 655 | # The exact variables and functions that may be referenced within an expression |
| 656 | # are determined by the service that evaluates it. See the service |
| 657 | # documentation for additional information. |
| 658 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 659 | # describes the expression, e.g. when hovered over it in a UI. |
| 660 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 661 | # reporting, e.g. a file name and a position in the file. |
| 662 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 663 | # syntax. |
| 664 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 665 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 666 | # expression. |
| 667 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 668 | }, |
| 669 | } |
| 670 | |
| 671 | x__xgafv: string, V1 error format. |
| 672 | Allowed values |
| 673 | 1 - v1 error format |
| 674 | 2 - v2 error format |
| 675 | |
| 676 | Returns: |
| 677 | An object of the form: |
| 678 | |
| 679 | { # An asset feed used to export asset updates to a destinations. |
| 680 | # An asset feed filter controls what updates are exported. |
| 681 | # The asset feed must be created within a project, organization, or |
| 682 | # folder. Supported destinations are: |
| 683 | # Pub/Sub topics. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 684 | "name": "A String", # Required. The format will be |
| 685 | # projects/{project_number}/feeds/{client-assigned_feed_identifier} or |
| 686 | # folders/{folder_number}/feeds/{client-assigned_feed_identifier} or |
| 687 | # organizations/{organization_number}/feeds/{client-assigned_feed_identifier} |
| 688 | # |
| 689 | # The client-assigned feed identifier must be unique within the parent |
| 690 | # project/folder/organization. |
| 691 | "contentType": "A String", # Asset content type. If not specified, no content but the asset name and |
| 692 | # type will be returned. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 693 | "assetTypes": [ # A list of types of the assets to receive updates. You must specify either |
| 694 | # or both of asset_names and asset_types. Only asset updates matching |
| 695 | # specified asset_names or asset_types are exported to the feed. |
| 696 | # Example: `"compute.googleapis.com/Disk"` |
| 697 | # |
| 698 | # See [this |
| 699 | # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) |
| 700 | # for a list of all supported asset types. |
| 701 | "A String", |
| 702 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 703 | "assetNames": [ # A list of the full names of the assets to receive updates. You must specify |
| 704 | # either or both of asset_names and asset_types. Only asset updates matching |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 705 | # specified asset_names or asset_types are exported to the feed. |
| 706 | # Example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 707 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 708 | # See [Resource |
| 709 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 710 | # for more info. |
| 711 | "A String", |
| 712 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 713 | "feedOutputConfig": { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are |
| 714 | # published to. |
| 715 | "pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub. |
| 716 | "topic": "A String", # The name of the Pub/Sub topic to publish to. |
| 717 | # Example: `projects/PROJECT_ID/topics/TOPIC_ID`. |
| 718 | }, |
| 719 | }, |
| 720 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition which determines whether an asset update should be published. |
| 721 | # If specified, an asset will be returned only when the expression evaluates |
| 722 | # to true. |
| 723 | # When set, `expression` field in the `Expr` must be a valid [CEL expression] |
| 724 | # (https://github.com/google/cel-spec) on a TemporalAsset with name |
| 725 | # `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted |
| 726 | # == true") will only publish Asset deletions. Other fields of `Expr` are |
| 727 | # optional. |
| 728 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 729 | # are documented at https://github.com/google/cel-spec. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 730 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 731 | # Example (Comparison): |
| 732 | # |
| 733 | # title: "Summary size limit" |
| 734 | # description: "Determines if a summary is less than 100 chars" |
| 735 | # expression: "document.summary.size() < 100" |
| 736 | # |
| 737 | # Example (Equality): |
| 738 | # |
| 739 | # title: "Requestor is owner" |
| 740 | # description: "Determines if requestor is the document owner" |
| 741 | # expression: "document.owner == request.auth.claims.email" |
| 742 | # |
| 743 | # Example (Logic): |
| 744 | # |
| 745 | # title: "Public documents" |
| 746 | # description: "Determine whether the document should be publicly visible" |
| 747 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 748 | # |
| 749 | # Example (Data Manipulation): |
| 750 | # |
| 751 | # title: "Notification string" |
| 752 | # description: "Create a notification string with a timestamp." |
| 753 | # expression: "'New message received at ' + string(document.create_time)" |
| 754 | # |
| 755 | # The exact variables and functions that may be referenced within an expression |
| 756 | # are determined by the service that evaluates it. See the service |
| 757 | # documentation for additional information. |
| 758 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 759 | # describes the expression, e.g. when hovered over it in a UI. |
| 760 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 761 | # reporting, e.g. a file name and a position in the file. |
| 762 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 763 | # syntax. |
| 764 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 765 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 766 | # expression. |
| 767 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 768 | }</pre> |
| 769 | </div> |
| 770 | |
| 771 | </body></html> |