blob: 5e0d97b3ee6eef4ea9b0584215f7d39f6c060acc [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudasset_v1.html">Cloud Asset API</a> . <a href="cloudasset_v1.feeds.html">feeds</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a feed in a parent project/folder/organization to listen to its</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an asset feed.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details about an asset feed.</p>
<p class="toc_element">
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all asset feeds in a parent project/folder/organization.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an asset feed configuration.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a feed in a parent project/folder/organization to listen to its
asset updates.
Args:
parent: string, Required. The name of the project/folder/organization where this feed
should be created in. It can only be an organization number (such as
&quot;organizations/123&quot;), a folder number (such as &quot;folders/123&quot;), a project ID
(such as &quot;projects/my-project-id&quot;)&quot;, or a project number (such as
&quot;projects/12345&quot;). (required)
body: object, The request body.
The object takes the form of:
{ # Create asset feed request.
&quot;feedId&quot;: &quot;A String&quot;, # Required. This is the client-assigned asset feed identifier and it needs to
# be unique under a specific parent project/folder/organization.
&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
# in the format of:
# projects/project_number/feeds/feed_id
# folders/folder_number/feeds/feed_id
# organizations/organization_number/feeds/feed_id
# An asset feed filter controls what updates are exported.
# The asset feed must be created within a project, organization, or
# folder. Supported destinations are:
# Pub/Sub topics.
&quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
# or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example: `&quot;compute.googleapis.com/Disk&quot;`
#
# See [this
# topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
# for a list of all supported asset types.
&quot;A String&quot;,
],
&quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
# published to.
&quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
&quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
# Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
},
},
&quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
# either or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example:
# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
# See [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more info.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The format will be
# projects/{project_number}/feeds/{client-assigned_feed_identifier} or
# folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
# organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
#
# The client-assigned feed identifier must be unique within the parent
# project/folder/organization.
&quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
# type will be returned.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An asset feed used to export asset updates to a destinations.
# An asset feed filter controls what updates are exported.
# The asset feed must be created within a project, organization, or
# folder. Supported destinations are:
# Pub/Sub topics.
&quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
# or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example: `&quot;compute.googleapis.com/Disk&quot;`
#
# See [this
# topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
# for a list of all supported asset types.
&quot;A String&quot;,
],
&quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
# published to.
&quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
&quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
# Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
},
},
&quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
# either or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example:
# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
# See [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more info.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The format will be
# projects/{project_number}/feeds/{client-assigned_feed_identifier} or
# folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
# organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
#
# The client-assigned feed identifier must be unique within the parent
# project/folder/organization.
&quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
# type will be returned.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an asset feed.
Args:
name: string, Required. The name of the feed and it must be in the format of:
projects/project_number/feeds/feed_id
folders/folder_number/feeds/feed_id
organizations/organization_number/feeds/feed_id (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details about an asset feed.
Args:
name: string, Required. The name of the Feed and it must be in the format of:
projects/project_number/feeds/feed_id
folders/folder_number/feeds/feed_id
organizations/organization_number/feeds/feed_id (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An asset feed used to export asset updates to a destinations.
# An asset feed filter controls what updates are exported.
# The asset feed must be created within a project, organization, or
# folder. Supported destinations are:
# Pub/Sub topics.
&quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
# or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example: `&quot;compute.googleapis.com/Disk&quot;`
#
# See [this
# topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
# for a list of all supported asset types.
&quot;A String&quot;,
],
&quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
# published to.
&quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
&quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
# Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
},
},
&quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
# either or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example:
# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
# See [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more info.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The format will be
# projects/{project_number}/feeds/{client-assigned_feed_identifier} or
# folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
# organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
#
# The client-assigned feed identifier must be unique within the parent
# project/folder/organization.
&quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
# type will be returned.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
<pre>Lists all asset feeds in a parent project/folder/organization.
Args:
parent: string, Required. The parent project/folder/organization whose feeds are to be
listed. It can only be using project/folder/organization number (such as
&quot;folders/12345&quot;)&quot;, or a project ID (such as &quot;projects/my-project-id&quot;). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;feeds&quot;: [ # A list of feeds.
{ # An asset feed used to export asset updates to a destinations.
# An asset feed filter controls what updates are exported.
# The asset feed must be created within a project, organization, or
# folder. Supported destinations are:
# Pub/Sub topics.
&quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
# or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example: `&quot;compute.googleapis.com/Disk&quot;`
#
# See [this
# topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
# for a list of all supported asset types.
&quot;A String&quot;,
],
&quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
# published to.
&quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
&quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
# Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
},
},
&quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
# either or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example:
# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
# See [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more info.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The format will be
# projects/{project_number}/feeds/{client-assigned_feed_identifier} or
# folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
# organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
#
# The client-assigned feed identifier must be unique within the parent
# project/folder/organization.
&quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
# type will be returned.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<pre>Updates an asset feed configuration.
Args:
name: string, Required. The format will be
projects/{project_number}/feeds/{client-assigned_feed_identifier} or
folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
The client-assigned feed identifier must be unique within the parent
project/folder/organization. (required)
body: object, The request body.
The object takes the form of:
{ # Update asset feed request.
&quot;updateMask&quot;: &quot;A String&quot;, # Required. Only updates the `feed` fields indicated by this mask.
# The field mask must not be empty, and it must not contain fields that
# are immutable or only set by the server.
&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
# field `name` must be in the format of:
# projects/project_number/feeds/feed_id or
# folders/folder_number/feeds/feed_id or
# organizations/organization_number/feeds/feed_id.
# An asset feed filter controls what updates are exported.
# The asset feed must be created within a project, organization, or
# folder. Supported destinations are:
# Pub/Sub topics.
&quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
# or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example: `&quot;compute.googleapis.com/Disk&quot;`
#
# See [this
# topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
# for a list of all supported asset types.
&quot;A String&quot;,
],
&quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
# published to.
&quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
&quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
# Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
},
},
&quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
# either or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example:
# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
# See [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more info.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The format will be
# projects/{project_number}/feeds/{client-assigned_feed_identifier} or
# folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
# organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
#
# The client-assigned feed identifier must be unique within the parent
# project/folder/organization.
&quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
# type will be returned.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An asset feed used to export asset updates to a destinations.
# An asset feed filter controls what updates are exported.
# The asset feed must be created within a project, organization, or
# folder. Supported destinations are:
# Pub/Sub topics.
&quot;assetTypes&quot;: [ # A list of types of the assets to receive updates. You must specify either
# or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example: `&quot;compute.googleapis.com/Disk&quot;`
#
# See [this
# topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
# for a list of all supported asset types.
&quot;A String&quot;,
],
&quot;feedOutputConfig&quot;: { # Output configuration for asset feed destination. # Required. Feed output configuration defining where the asset updates are
# published to.
&quot;pubsubDestination&quot;: { # A Pub/Sub destination. # Destination on Pub/Sub.
&quot;topic&quot;: &quot;A String&quot;, # The name of the Pub/Sub topic to publish to.
# Example: `projects/PROJECT_ID/topics/TOPIC_ID`.
},
},
&quot;assetNames&quot;: [ # A list of the full names of the assets to receive updates. You must specify
# either or both of asset_names and asset_types. Only asset updates matching
# specified asset_names or asset_types are exported to the feed.
# Example:
# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
# See [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more info.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The format will be
# projects/{project_number}/feeds/{client-assigned_feed_identifier} or
# folders/{folder_number}/feeds/{client-assigned_feed_identifier} or
# organizations/{organization_number}/feeds/{client-assigned_feed_identifier}
#
# The client-assigned feed identifier must be unique within the parent
# project/folder/organization.
&quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name and
# type will be returned.
}</pre>
</div>
</body></html>