@google-cloud/asset

import * as gax from 'google-gax'; import { Callback, CallOptions, Descriptors, ClientOptions, LROperation } from 'google-gax'; import * as protos from '../../protos/protos'; /** * Asset service definition. * @class * @memberof v1p4beta1 */ export declare class AssetServiceClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; operationsClient: gax.OperationsClient; 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://developers.google.com/identity/protocols/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 | "rest"} [options.fallback] - Use HTTP fallback mode. * Pass "rest" to use HTTP/1.1 REST API instead of gRPC. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. */ constructor(opts?: ClientOptions); /** * 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. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath(), * exists for compatibility reasons. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): 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; /** * Analyzes IAM policies based on the specified request. Returns * a list of {@link google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult|IamPolicyAnalysisResult} matching the request. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery} request.analysisQuery * Required. The request query. * @param {google.cloud.asset.v1p4beta1.AnalyzeIamPolicyRequest.Options} [request.options] * Optional. The request options. * @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 an object representing [AnalyzeIamPolicyResponse]{@link google.cloud.asset.v1p4beta1.AnalyzeIamPolicyResponse}. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) * for more details and examples. * @example <caption>include:samples/generated/v1p4beta1/asset_service.analyze_iam_policy.js</caption> * region_tag:cloudasset_v1p4beta1_generated_AssetService_AnalyzeIamPolicy_async */ analyzeIamPolicy(request?: protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest | undefined, {} | undefined ]>; analyzeIamPolicy(request: protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest | null | undefined, {} | null | undefined>): void; analyzeIamPolicy(request: protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest, callback: Callback<protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Exports IAM policy analysis based on the specified request. This API * implements the {@link google.longrunning.Operation|google.longrunning.Operation} API allowing you to keep * track of the export. The metadata contains the request to help callers to * map responses to requests. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery} request.analysisQuery * Required. The request query. * @param {google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisRequest.Options} [request.options] * Optional. The request options. * @param {google.cloud.asset.v1p4beta1.IamPolicyAnalysisOutputConfig} request.outputConfig * Required. Output configuration indicating where the results will be output to. * @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 an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) * for more details and examples. * @example <caption>include:samples/generated/v1p4beta1/asset_service.export_iam_policy_analysis.js</caption> * region_tag:cloudasset_v1p4beta1_generated_AssetService_ExportIamPolicyAnalysis_async */ exportIamPolicyAnalysis(request?: protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisResponse, protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; exportIamPolicyAnalysis(request: protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisResponse, protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; exportIamPolicyAnalysis(request: protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest, callback: Callback<LROperation<protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisResponse, protos.google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `exportIamPolicyAnalysis()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) * for more details and examples. * @example <caption>include:samples/generated/v1p4beta1/asset_service.export_iam_policy_analysis.js</caption> * region_tag:cloudasset_v1p4beta1_generated_AssetService_ExportIamPolicyAnalysis_async */ checkExportIamPolicyAnalysisProgress(name: string): Promise<LROperation<protos.google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisResponse, protos.google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisRequest>>; /** * 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>; }