AssetServiceClient

Asset service definition.

Constructor

new AssetServiceClient(optionsopt)

Construct an instance of AssetServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. See the subsequent parameters for more details.

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise

function

Custom promise module to use instead of native Promises.

apiEndpoint

string

The domain name of the API remote host.

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

(static) port

The port for this API service.

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

(static) servicePath

The DNS address for this API service.

Methods

batchGetAssetsHistory(request, optionsopt) → {Promise}

Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").
`assetNames`	Array.<string>		A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See Resource Names and Resource Name Format for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request.
`contentType`	google.cloud.asset.v1.ContentType	<optional>	Optional. The content type.
`readTimeWindow`	google.cloud.asset.v1.TimeWindow	<optional>	Optional. The time window for the asset history. Both start_time and end_time are optional and if set, it must be after 2018-10-02 UTC. If end_time is not set, it is default to current timestamp. If start_time is not set, the snapshot of the assets at end_time will be returned. The returned results contain all temporal assets whose time window overlap with read_time_window.

options

object

Call options. See CallOptions for more details.

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

createFeed(request, optionsopt) → {Promise}

Creates a feed in a parent project/folder/organization to listen to its asset updates.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`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 "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").
`feedId`	string	Required. This is the client-assigned asset feed identifier and it needs to be unique under a specific parent project/folder/organization.
`feed`	google.cloud.asset.v1.Feed	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

options

object

Call options. See CallOptions for more details.

deleteFeed(request, optionsopt) → {Promise}

Deletes an asset feed.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`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

options

object

Call options. See CallOptions for more details.

exportAssets(request, optionsopt) → {Promise}

Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API allowing you to keep track of the export.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123").
`readTime`	google.protobuf.Timestamp	Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.
`assetTypes`	Array.<string>	A list of asset types of which to take a snapshot for. For example: "compute.googleapis.com/Disk". If specified, only matching assets will be returned. See Introduction to Cloud Asset Inventory for all supported asset types.
`contentType`	google.cloud.asset.v1.ContentType	Asset content type. If not specified, no content but the asset name will be returned.
`outputConfig`	google.cloud.asset.v1.OutputConfig	Required. Output configuration indicating where the results will be output to. All results will be in newline delimited JSON format.

options

object

Call options. See CallOptions for more details.

folderFeedPath(folder, feed) → {string}

Return a fully-qualified folderFeed resource name string.

Parameters:

Name	Type	Description
`folder`	string
`feed`	string

getFeed(request, optionsopt) → {Promise}

Gets details about an asset feed.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`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

options

object

Call options. See CallOptions for more details.

getProjectId(callback)

Return the project ID used by this class.

Parameters:

Name	Type	Description
`callback`	function	the callback to be called with the current project Id.

listFeeds(request, optionsopt) → {Promise}

Lists all asset feeds in a parent project/folder/organization.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`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 "folders/12345")", or a project ID (such as "projects/my-project-id").

options

object

Call options. See CallOptions for more details.

matchFeedFromFolderFeedName(folderFeedName) → {string}

Parse the feed from FolderFeed resource.

Parameters:

Name	Type	Description
`folderFeedName`	string	A fully-qualified path representing folder_feed resource.

matchFeedFromOrganizationFeedName(organizationFeedName) → {string}

Parse the feed from OrganizationFeed resource.

Parameters:

Name	Type	Description
`organizationFeedName`	string	A fully-qualified path representing organization_feed resource.

matchFeedFromProjectFeedName(projectFeedName) → {string}

Parse the feed from ProjectFeed resource.

Parameters:

Name	Type	Description
`projectFeedName`	string	A fully-qualified path representing project_feed resource.

matchFolderFromFolderFeedName(folderFeedName) → {string}

Parse the folder from FolderFeed resource.

Parameters:

Name	Type	Description
`folderFeedName`	string	A fully-qualified path representing folder_feed resource.

matchOrganizationFromOrganizationFeedName(organizationFeedName) → {string}

Parse the organization from OrganizationFeed resource.

Parameters:

Name	Type	Description
`organizationFeedName`	string	A fully-qualified path representing organization_feed resource.

matchProjectFromProjectFeedName(projectFeedName) → {string}

Parse the project from ProjectFeed resource.

Parameters:

Name	Type	Description
`projectFeedName`	string	A fully-qualified path representing project_feed resource.

organizationFeedPath(organization, feed) → {string}

Return a fully-qualified organizationFeed resource name string.

Parameters:

Name	Type	Description
`organization`	string
`feed`	string

projectFeedPath(project, feed) → {string}

Return a fully-qualified projectFeed resource name string.

Parameters:

Name	Type	Description
`project`	string
`feed`	string

updateFeed(request, optionsopt) → {Promise}

Updates an asset feed configuration.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`feed`	google.cloud.asset.v1.Feed	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.
`updateMask`	google.protobuf.FieldMask	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.

options

object

Call options. See CallOptions for more details.