@google-cloud/asset/build/src/v1p1beta1/asset_service_client.d.ts

Cloud Asset API client for Node.js

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 v1p1beta1
 */
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;
    };
    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;
    /**
    * Searches all the resources within a given accessible Resource Manager scope
    * (project/folder/organization). This RPC gives callers especially
    * administrators the ability to search all the resources within a scope, even
    * if they don't have `.get` permission of all the resources. Callers should
    * have `cloudasset.assets.searchAllResources` permission on the requested
    * scope, otherwise the request will be rejected.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.scope
    *   Required. The relative name of an asset. The search is limited to the
    *   resources within the `scope`. The allowed value must be:
    *
    *   * Organization number (such as "organizations/123")
    *   * Folder number (such as "folders/1234")
    *   * Project number (such as "projects/12345")
    *   * Project ID (such as "projects/abc")
    * @param {string} [request.query]
    *   Optional. The query statement.
    * @param {string[]} [request.assetTypes]
    *   Optional. A list of asset types that this request searches for. If empty,
    *   it will search all the supported asset types.
    * @param {number} [request.pageSize]
    *   Optional. The page size for search result pagination. Page size is capped
    *   at 500 even if a larger value is given. If set to zero, server will pick an
    *   appropriate default. Returned results may be fewer than requested. When
    *   this happens, there could be more results as long as `next_page_token` is
    *   returned.
    * @param {string} [request.pageToken]
    *   Optional. If present, then retrieve the next batch of results from the
    *   preceding call to this method.  `page_token` must be the value of
    *   `next_page_token` from the previous response. The values of all other
    *   method parameters, must be identical to those in the previous call.
    * @param {string} [request.orderBy]
    *   Optional. A comma separated list of fields specifying the sorting order of
    *   the results. The default order is ascending. Add ` DESC` after the field
    *   name to indicate descending order. Redundant space characters are ignored.
    *   For example, `  location DESC ,  name  `.
    * @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.v1p1beta1.StandardResourceMetadata|StandardResourceMetadata}.
    *   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 `searchAllResourcesAsync()`
    *   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.
    */
    searchAllResources(request?: protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata[],
        protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest | null,
        protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse
    ]>;
    searchAllResources(request: protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse | null | undefined, protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata>): void;
    searchAllResources(request: protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, callback: PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse | null | undefined, protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata>): void;
    /**
     * Equivalent to `searchAllResources`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.scope
     *   Required. The relative name of an asset. The search is limited to the
     *   resources within the `scope`. The allowed value must be:
     *
     *   * Organization number (such as "organizations/123")
     *   * Folder number (such as "folders/1234")
     *   * Project number (such as "projects/12345")
     *   * Project ID (such as "projects/abc")
     * @param {string} [request.query]
     *   Optional. The query statement.
     * @param {string[]} [request.assetTypes]
     *   Optional. A list of asset types that this request searches for. If empty,
     *   it will search all the supported asset types.
     * @param {number} [request.pageSize]
     *   Optional. The page size for search result pagination. Page size is capped
     *   at 500 even if a larger value is given. If set to zero, server will pick an
     *   appropriate default. Returned results may be fewer than requested. When
     *   this happens, there could be more results as long as `next_page_token` is
     *   returned.
     * @param {string} [request.pageToken]
     *   Optional. If present, then retrieve the next batch of results from the
     *   preceding call to this method.  `page_token` must be the value of
     *   `next_page_token` from the previous response. The values of all other
     *   method parameters, must be identical to those in the previous call.
     * @param {string} [request.orderBy]
     *   Optional. A comma separated list of fields specifying the sorting order of
     *   the results. The default order is ascending. Add ` DESC` after the field
     *   name to indicate descending order. Redundant space characters are ignored.
     *   For example, `  location DESC ,  name  `.
     * @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.v1p1beta1.StandardResourceMetadata|StandardResourceMetadata} 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 `searchAllResourcesAsync()`
     *   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.
     */
    searchAllResourcesStream(request?: protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `searchAllResources`, 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.scope
     *   Required. The relative name of an asset. The search is limited to the
     *   resources within the `scope`. The allowed value must be:
     *
     *   * Organization number (such as "organizations/123")
     *   * Folder number (such as "folders/1234")
     *   * Project number (such as "projects/12345")
     *   * Project ID (such as "projects/abc")
     * @param {string} [request.query]
     *   Optional. The query statement.
     * @param {string[]} [request.assetTypes]
     *   Optional. A list of asset types that this request searches for. If empty,
     *   it will search all the supported asset types.
     * @param {number} [request.pageSize]
     *   Optional. The page size for search result pagination. Page size is capped
     *   at 500 even if a larger value is given. If set to zero, server will pick an
     *   appropriate default. Returned results may be fewer than requested. When
     *   this happens, there could be more results as long as `next_page_token` is
     *   returned.
     * @param {string} [request.pageToken]
     *   Optional. If present, then retrieve the next batch of results from the
     *   preceding call to this method.  `page_token` must be the value of
     *   `next_page_token` from the previous response. The values of all other
     *   method parameters, must be identical to those in the previous call.
     * @param {string} [request.orderBy]
     *   Optional. A comma separated list of fields specifying the sorting order of
     *   the results. The default order is ascending. Add ` DESC` after the field
     *   name to indicate descending order. Redundant space characters are ignored.
     *   For example, `  location DESC ,  name  `.
     * @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.v1p1beta1.StandardResourceMetadata|StandardResourceMetadata}. 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/v1p1beta1/asset_service.search_all_resources.js</caption>
     * region_tag:cloudasset_v1p1beta1_generated_AssetService_SearchAllResources_async
     */
    searchAllResourcesAsync(request?: protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata>;
    /**
    * Searches all the IAM policies within a given accessible Resource Manager
    * scope (project/folder/organization). This RPC gives callers especially
    * administrators the ability to search all the IAM policies within a scope,
    * even if they don't have `.getIamPolicy` permission of all the IAM policies.
    * Callers should have `cloudasset.assets.searchAllIamPolicies` permission on
    * the requested scope, otherwise the request will be rejected.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.scope
    *   Required. The relative name of an asset. The search is limited to the
    *   resources within the `scope`. The allowed value must be:
    *
    *   * Organization number (such as "organizations/123")
    *   * Folder number (such as "folders/1234")
    *   * Project number (such as "projects/12345")
    *   * Project ID (such as "projects/abc")
    * @param {string} [request.query]
    *   Optional. The query statement. Examples:
    *
    *   * "policy:myuser@mydomain.com"
    *   * "policy:(myuser@mydomain.com viewer)"
    * @param {number} [request.pageSize]
    *   Optional. The page size for search result pagination. Page size is capped
    *   at 500 even if a larger value is given. If set to zero, server will pick an
    *   appropriate default. Returned results may be fewer than requested. When
    *   this happens, there could be more results as long as `next_page_token` is
    *   returned.
    * @param {string} [request.pageToken]
    *   Optional. If present, retrieve the next batch of results from the preceding
    *   call to this method. `page_token` must be the value of `next_page_token`
    *   from the previous response. The values of all other method parameters must
    *   be identical to those in the previous call.
    * @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.v1p1beta1.IamPolicySearchResult|IamPolicySearchResult}.
    *   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 `searchAllIamPoliciesAsync()`
    *   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.
    */
    searchAllIamPolicies(request?: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult[],
        protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest | null,
        protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse
    ]>;
    searchAllIamPolicies(request: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse | null | undefined, protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult>): void;
    searchAllIamPolicies(request: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, callback: PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse | null | undefined, protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult>): void;
    /**
     * Equivalent to `searchAllIamPolicies`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.scope
     *   Required. The relative name of an asset. The search is limited to the
     *   resources within the `scope`. The allowed value must be:
     *
     *   * Organization number (such as "organizations/123")
     *   * Folder number (such as "folders/1234")
     *   * Project number (such as "projects/12345")
     *   * Project ID (such as "projects/abc")
     * @param {string} [request.query]
     *   Optional. The query statement. Examples:
     *
     *   * "policy:myuser@mydomain.com"
     *   * "policy:(myuser@mydomain.com viewer)"
     * @param {number} [request.pageSize]
     *   Optional. The page size for search result pagination. Page size is capped
     *   at 500 even if a larger value is given. If set to zero, server will pick an
     *   appropriate default. Returned results may be fewer than requested. When
     *   this happens, there could be more results as long as `next_page_token` is
     *   returned.
     * @param {string} [request.pageToken]
     *   Optional. If present, retrieve the next batch of results from the preceding
     *   call to this method. `page_token` must be the value of `next_page_token`
     *   from the previous response. The values of all other method parameters must
     *   be identical to those in the previous call.
     * @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.v1p1beta1.IamPolicySearchResult|IamPolicySearchResult} 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 `searchAllIamPoliciesAsync()`
     *   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.
     */
    searchAllIamPoliciesStream(request?: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `searchAllIamPolicies`, 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.scope
     *   Required. The relative name of an asset. The search is limited to the
     *   resources within the `scope`. The allowed value must be:
     *
     *   * Organization number (such as "organizations/123")
     *   * Folder number (such as "folders/1234")
     *   * Project number (such as "projects/12345")
     *   * Project ID (such as "projects/abc")
     * @param {string} [request.query]
     *   Optional. The query statement. Examples:
     *
     *   * "policy:myuser@mydomain.com"
     *   * "policy:(myuser@mydomain.com viewer)"
     * @param {number} [request.pageSize]
     *   Optional. The page size for search result pagination. Page size is capped
     *   at 500 even if a larger value is given. If set to zero, server will pick an
     *   appropriate default. Returned results may be fewer than requested. When
     *   this happens, there could be more results as long as `next_page_token` is
     *   returned.
     * @param {string} [request.pageToken]
     *   Optional. If present, retrieve the next batch of results from the preceding
     *   call to this method. `page_token` must be the value of `next_page_token`
     *   from the previous response. The values of all other method parameters must
     *   be identical to those in the previous call.
     * @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.v1p1beta1.IamPolicySearchResult|IamPolicySearchResult}. 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/v1p1beta1/asset_service.search_all_iam_policies.js</caption>
     * region_tag:cloudasset_v1p1beta1_generated_AssetService_SearchAllIamPolicies_async
     */
    searchAllIamPoliciesAsync(request?: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult>;
    /**
     * 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>;
}