@google-cloud/asset

import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Asset service definition. * @class * @memberof v1p5beta1 */ export declare class AssetServiceClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; pathTemplates: { [name: string]: gax.PathTemplate; }; assetServiceStub?: Promise<{ [name: string]: Function; }>; /** * 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?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * 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(): Promise<{ [name: string]: Function; }>; /** * 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(): string; /** * 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(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; /** * Lists assets with time and resource types and returns paged results in * response. * * @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 {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.asset.v1p5beta1.Asset|Asset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * 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. */ listAssets(request?: protos.google.cloud.asset.v1p5beta1.IListAssetsRequest, options?: CallOptions): Promise<[ protos.google.cloud.asset.v1p5beta1.IAsset[], protos.google.cloud.asset.v1p5beta1.IListAssetsRequest | null, protos.google.cloud.asset.v1p5beta1.IListAssetsResponse ]>; listAssets(request: protos.google.cloud.asset.v1p5beta1.IListAssetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.asset.v1p5beta1.IListAssetsRequest, protos.google.cloud.asset.v1p5beta1.IListAssetsResponse | null | undefined, protos.google.cloud.asset.v1p5beta1.IAsset>): void; listAssets(request: protos.google.cloud.asset.v1p5beta1.IListAssetsRequest, callback: PaginationCallback<protos.google.cloud.asset.v1p5beta1.IListAssetsRequest, protos.google.cloud.asset.v1p5beta1.IListAssetsResponse | null | undefined, protos.google.cloud.asset.v1p5beta1.IAsset>): void; /** * 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?: protos.google.cloud.asset.v1p5beta1.IListAssetsRequest, options?: CallOptions): Transform; /** * 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?: protos.google.cloud.asset.v1p5beta1.IListAssetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.asset.v1p5beta1.IAsset>; /** * Return a fully-qualified accessLevel resource name string. * * @param {string} access_policy * @param {string} access_level * @returns {string} Resource name string. */ accessLevelPath(accessPolicy: string, accessLevel: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * Return a fully-qualified accessPolicy resource name string. * * @param {string} access_policy * @returns {string} Resource name string. */ accessPolicyPath(accessPolicy: string): string; /** * 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: string): string | number; /** * Return a fully-qualified servicePerimeter resource name string. * * @param {string} access_policy * @param {string} service_perimeter * @returns {string} Resource name string. */ servicePerimeterPath(accessPolicy: string, servicePerimeter: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * 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(): Promise<void>; }