Google Cloud Asset V1 Client - Class Feed (2.1.0)

Reference documentation and code samples for the Google Cloud Asset V1 Client class Feed.

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.

Generated from protobuf message google.cloud.asset.v1.Feed

Namespace

Google \ Cloud \ Asset \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ 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.
↳ asset_names array

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. For a list of the full names for supported asset types, see Resource name format.
↳ asset_types array

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: "compute.googleapis.com/Disk" For a list of all supported asset types, see Supported asset types.
↳ content_type int

Asset content type. If not specified, no content but the asset name and type will be returned.
↳ feed_output_config Google\Cloud\Asset\V1\FeedOutputConfig

Required. Feed output configuration defining where the asset updates are published to.
↳ condition Google\Type\Expr

A condition which determines whether an asset update should be published. If specified, an asset will be returned only when the expression evaluates to true. When set, expression field in the Expr must be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with expression ("temporal_asset.deleted == true") will only publish Asset deletions. Other fields of Expr are optional. See our user guide for detailed instructions.
↳ relationship_types array

A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP. * If specified: it outputs specified relationship updates on the [asset_names] or the [asset_types]. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_names] or [asset_types], or any of the [asset_names] or the [asset_types] doesn't belong to the source types of the [relationship_types]. * Otherwise: it outputs the supported relationships of the types of [asset_names] and [asset_types] or returns an error if any of the [asset_names] or the [asset_types] has no replationship support. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

getName

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.

Returns
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getAssetNames

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. For a list of the full names for supported asset types, see Resource name format.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAssetNames

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. For a list of the full names for supported asset types, see Resource name format.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getAssetTypes

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: "compute.googleapis.com/Disk" For a list of all supported asset types, see Supported asset types.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAssetTypes

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: "compute.googleapis.com/Disk" For a list of all supported asset types, see Supported asset types.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getContentType

Asset content type. If not specified, no content but the asset name and type will be returned.

Returns
Type Description
int

setContentType

Asset content type. If not specified, no content but the asset name and type will be returned.

Parameter
Name Description
var int
Returns
Type Description
$this

getFeedOutputConfig

Required. Feed output configuration defining where the asset updates are published to.

Returns
Type Description
Google\Cloud\Asset\V1\FeedOutputConfig|null

hasFeedOutputConfig

clearFeedOutputConfig

setFeedOutputConfig

Required. Feed output configuration defining where the asset updates are published to.

Parameter
Name Description
var Google\Cloud\Asset\V1\FeedOutputConfig
Returns
Type Description
$this

getCondition

A condition which determines whether an asset update should be published.

If specified, an asset will be returned only when the expression evaluates to true. When set, expression field in the Expr must be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with expression ("temporal_asset.deleted == true") will only publish Asset deletions. Other fields of Expr are optional. See our user guide for detailed instructions.

Returns
Type Description
Google\Type\Expr|null

hasCondition

clearCondition

setCondition

A condition which determines whether an asset update should be published.

If specified, an asset will be returned only when the expression evaluates to true. When set, expression field in the Expr must be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with expression ("temporal_asset.deleted == true") will only publish Asset deletions. Other fields of Expr are optional. See our user guide for detailed instructions.

Parameter
Name Description
var Google\Type\Expr
Returns
Type Description
$this

getRelationshipTypes

A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

  • If specified: it outputs specified relationship updates on the [asset_names] or the [asset_types]. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_names] or [asset_types], or any of the [asset_names] or the [asset_types] doesn't belong to the source types of the [relationship_types].
  • Otherwise: it outputs the supported relationships of the types of [asset_names] and [asset_types] or returns an error if any of the [asset_names] or the [asset_types] has no replationship support. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRelationshipTypes

A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

  • If specified: it outputs specified relationship updates on the [asset_names] or the [asset_types]. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_names] or [asset_types], or any of the [asset_names] or the [asset_types] doesn't belong to the source types of the [relationship_types].
  • Otherwise: it outputs the supported relationships of the types of [asset_names] and [asset_types] or returns an error if any of the [asset_names] or the [asset_types] has no replationship support. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.
Parameter
Name Description
var string[]
Returns
Type Description
$this