@google-cloud/asset
Version:
Cloud Asset API client for Node.js
564 lines • 27.7 kB
JavaScript
"use strict";
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
Object.defineProperty(exports, "__esModule", { value: true });
exports.AssetServiceClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v1p5beta1/asset_service_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./asset_service_client_config.json");
const version = require('../../../package.json').version;
/**
* Asset service definition.
* @class
* @memberof v1p5beta1
*/
class AssetServiceClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('asset');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
pathTemplates;
assetServiceStub;
/**
* Construct an instance of AssetServiceClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - 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.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - 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
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new AssetServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts, gaxInstance) {
// Ensure that options include all the required fields.
const staticMembers = this.constructor;
if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
throw new Error('Please set either universe_domain or universeDomain, but not both.');
}
const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
this._servicePath = 'cloudasset.' + this._universeDomain;
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
// Request numeric enum values if REST transport is used.
opts.numericEnums = true;
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== this._servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Load google-gax module synchronously if needed
if (!gaxInstance) {
gaxInstance = require('google-gax');
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth;
// Set useJWTAccessWithScope on the auth object.
this.auth.useJWTAccessWithScope = true;
// Set defaultServicePath on the auth object.
this.auth.defaultServicePath = this._servicePath;
// Set the default scopes in auth client if needed.
if (servicePath === this._servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
// Determine the client header string.
const clientHeader = [
`gax/${this._gaxModule.version}`,
`gapic/${version}`,
];
if (typeof process === 'object' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// This API contains "path templates"; forward-slash-separated
// identifiers to uniquely identify resources within the API.
// Create useful helper objects for these.
this.pathTemplates = {
accessLevelPathTemplate: new this._gaxModule.PathTemplate('accessPolicies/{access_policy}/accessLevels/{access_level}'),
accessPolicyPathTemplate: new this._gaxModule.PathTemplate('accessPolicies/{access_policy}'),
servicePerimeterPathTemplate: new this._gaxModule.PathTemplate('accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}'),
};
// Some of the methods on this service return "paged" results,
// (e.g. 50 results at a time, with tokens to get subsequent
// pages). Denote the keys used for pagination and results.
this.descriptors.page = {
listAssets: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'assets')
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.asset.v1p5beta1.AssetService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = this._gaxModule.warn;
}
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize() {
// If the client stub promise is already initialized, return immediately.
if (this.assetServiceStub) {
return this.assetServiceStub;
}
// Put together the "service stub" for
// google.cloud.asset.v1p5beta1.AssetService.
this.assetServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.cloud.asset.v1p5beta1.AssetService') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.asset.v1p5beta1.AssetService, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const assetServiceStubMethods = ['listAssets'];
for (const methodName of assetServiceStubMethods) {
const callPromise = this.assetServiceStub.then(stub => (...args) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
}, (err) => () => {
throw err;
});
const descriptor = this.descriptors.page[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.assetServiceStub;
}
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'cloudasset.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'cloudasset.googleapis.com';
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint() {
return this._servicePath;
}
get universeDomain() {
return this._universeDomain;
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/cloud-platform'
];
}
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(callback) {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
listAssets(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('listAssets values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('listAssets request %j', request);
return this.innerApiCalls
.listAssets(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listAssets values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listAssets`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. Name of the organization or project the assets belong to. Format:
* "organizations/[organization-number]" (such as "organizations/123"),
* "projects/[project-id]" (such as "projects/my-project-id"), or
* "projects/[project-number]" (such as "projects/12345").
* @param {google.protobuf.Timestamp} request.readTime
* Timestamp to take an asset snapshot. This can only be set to a timestamp
* between the current time and the current time minus 35 days (inclusive).
* 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.
* @param {string[]} request.assetTypes
* A list of asset types to take a snapshot for. For example:
* "compute.googleapis.com/Disk".
*
* Regular expression is also supported. For example:
*
* * "compute.googleapis.com.*" snapshots resources whose asset type starts
* with "compute.googleapis.com".
* * ".*Instance" snapshots resources whose asset type ends with "Instance".
* * ".*Instance.*" snapshots resources whose asset type contains "Instance".
*
* See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported
* regular expression syntax. If the regular expression does not match any
* supported asset type, an INVALID_ARGUMENT error will be returned.
*
* If specified, only matching assets will be returned, otherwise, it will
* snapshot all asset types. See [Introduction to Cloud Asset
* Inventory](https://cloud.google.com/asset-inventory/docs/overview)
* for all supported asset types.
* @param {google.cloud.asset.v1p5beta1.ContentType} request.contentType
* Asset content type. If not specified, no content but the asset name will
* be returned.
* @param {number} request.pageSize
* The maximum number of assets to be returned in a single response. Default
* is 100, minimum is 1, and maximum is 1000.
* @param {string} request.pageToken
* The `next_page_token` returned from the previous `ListAssetsResponse`, or
* unspecified for the first `ListAssetsRequest`. It is a continuation of a
* prior `ListAssets` call, and the API should return the next page of assets.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.asset.v1p5beta1.Asset|Asset} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listAssetsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listAssetsStream(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
const defaultCallSettings = this._defaults['listAssets'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listAssets stream %j', request);
return this.descriptors.page.listAssets.createStream(this.innerApiCalls.listAssets, request, callSettings);
}
/**
* Equivalent to `listAssets`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. Name of the organization or project the assets belong to. Format:
* "organizations/[organization-number]" (such as "organizations/123"),
* "projects/[project-id]" (such as "projects/my-project-id"), or
* "projects/[project-number]" (such as "projects/12345").
* @param {google.protobuf.Timestamp} request.readTime
* Timestamp to take an asset snapshot. This can only be set to a timestamp
* between the current time and the current time minus 35 days (inclusive).
* 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.
* @param {string[]} request.assetTypes
* A list of asset types to take a snapshot for. For example:
* "compute.googleapis.com/Disk".
*
* Regular expression is also supported. For example:
*
* * "compute.googleapis.com.*" snapshots resources whose asset type starts
* with "compute.googleapis.com".
* * ".*Instance" snapshots resources whose asset type ends with "Instance".
* * ".*Instance.*" snapshots resources whose asset type contains "Instance".
*
* See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported
* regular expression syntax. If the regular expression does not match any
* supported asset type, an INVALID_ARGUMENT error will be returned.
*
* If specified, only matching assets will be returned, otherwise, it will
* snapshot all asset types. See [Introduction to Cloud Asset
* Inventory](https://cloud.google.com/asset-inventory/docs/overview)
* for all supported asset types.
* @param {google.cloud.asset.v1p5beta1.ContentType} request.contentType
* Asset content type. If not specified, no content but the asset name will
* be returned.
* @param {number} request.pageSize
* The maximum number of assets to be returned in a single response. Default
* is 100, minimum is 1, and maximum is 1000.
* @param {string} request.pageToken
* The `next_page_token` returned from the previous `ListAssetsResponse`, or
* unspecified for the first `ListAssetsRequest`. It is a continuation of a
* prior `ListAssets` call, and the API should return the next page of assets.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.asset.v1p5beta1.Asset|Asset}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1p5beta1/asset_service.list_assets.js</caption>
* region_tag:cloudasset_v1p5beta1_generated_AssetService_ListAssets_async
*/
listAssetsAsync(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
const defaultCallSettings = this._defaults['listAssets'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listAssets iterate %j', request);
return this.descriptors.page.listAssets.asyncIterate(this.innerApiCalls['listAssets'], request, callSettings);
}
// --------------------
// -- Path templates --
// --------------------
/**
* Return a fully-qualified accessLevel resource name string.
*
* @param {string} access_policy
* @param {string} access_level
* @returns {string} Resource name string.
*/
accessLevelPath(accessPolicy, accessLevel) {
return this.pathTemplates.accessLevelPathTemplate.render({
access_policy: accessPolicy,
access_level: accessLevel,
});
}
/**
* Parse the access_policy from AccessLevel resource.
*
* @param {string} accessLevelName
* A fully-qualified path representing AccessLevel resource.
* @returns {string} A string representing the access_policy.
*/
matchAccessPolicyFromAccessLevelName(accessLevelName) {
return this.pathTemplates.accessLevelPathTemplate.match(accessLevelName).access_policy;
}
/**
* Parse the access_level from AccessLevel resource.
*
* @param {string} accessLevelName
* A fully-qualified path representing AccessLevel resource.
* @returns {string} A string representing the access_level.
*/
matchAccessLevelFromAccessLevelName(accessLevelName) {
return this.pathTemplates.accessLevelPathTemplate.match(accessLevelName).access_level;
}
/**
* Return a fully-qualified accessPolicy resource name string.
*
* @param {string} access_policy
* @returns {string} Resource name string.
*/
accessPolicyPath(accessPolicy) {
return this.pathTemplates.accessPolicyPathTemplate.render({
access_policy: accessPolicy,
});
}
/**
* Parse the access_policy from AccessPolicy resource.
*
* @param {string} accessPolicyName
* A fully-qualified path representing AccessPolicy resource.
* @returns {string} A string representing the access_policy.
*/
matchAccessPolicyFromAccessPolicyName(accessPolicyName) {
return this.pathTemplates.accessPolicyPathTemplate.match(accessPolicyName).access_policy;
}
/**
* Return a fully-qualified servicePerimeter resource name string.
*
* @param {string} access_policy
* @param {string} service_perimeter
* @returns {string} Resource name string.
*/
servicePerimeterPath(accessPolicy, servicePerimeter) {
return this.pathTemplates.servicePerimeterPathTemplate.render({
access_policy: accessPolicy,
service_perimeter: servicePerimeter,
});
}
/**
* Parse the access_policy from ServicePerimeter resource.
*
* @param {string} servicePerimeterName
* A fully-qualified path representing ServicePerimeter resource.
* @returns {string} A string representing the access_policy.
*/
matchAccessPolicyFromServicePerimeterName(servicePerimeterName) {
return this.pathTemplates.servicePerimeterPathTemplate.match(servicePerimeterName).access_policy;
}
/**
* Parse the service_perimeter from ServicePerimeter resource.
*
* @param {string} servicePerimeterName
* A fully-qualified path representing ServicePerimeter resource.
* @returns {string} A string representing the service_perimeter.
*/
matchServicePerimeterFromServicePerimeterName(servicePerimeterName) {
return this.pathTemplates.servicePerimeterPathTemplate.match(servicePerimeterName).service_perimeter;
}
/**
* Terminate the gRPC channel and close the client.
*
* The client will no longer be usable and all future behavior is undefined.
* @returns {Promise} A promise that resolves when the client is closed.
*/
close() {
if (this.assetServiceStub && !this._terminated) {
return this.assetServiceStub.then(stub => {
this._log.info('ending gRPC channel');
this._terminated = true;
stub.close();
});
}
return Promise.resolve();
}
}
exports.AssetServiceClient = AssetServiceClient;
//# sourceMappingURL=asset_service_client.js.map