@google-cloud/chronicle/build/src/v1/entity_service_client.d.ts

Chronicle 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';
/**
 *  EntityService contains apis for finding entities.
 * @class
 * @memberof v1
 */
export declare class EntityServiceClient {
    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;
    };
    entityServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of EntityServiceClient.
     *
     * @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 EntityServiceClient({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;
    /**
     * Gets watchlist details for the given watchlist ID.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The parent, which owns this collection of watchlists.
     *   The name of the watchlist to retrieve.
     *   Format:
     *   `projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}`
     * @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 {@link protos.google.cloud.chronicle.v1.Watchlist|Watchlist}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/entity_service.get_watchlist.js</caption>
     * region_tag:chronicle_v1_generated_EntityService_GetWatchlist_async
     */
    getWatchlist(request?: protos.google.cloud.chronicle.v1.IGetWatchlistRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IWatchlist,
        protos.google.cloud.chronicle.v1.IGetWatchlistRequest | undefined,
        {} | undefined
    ]>;
    getWatchlist(request: protos.google.cloud.chronicle.v1.IGetWatchlistRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IWatchlist, protos.google.cloud.chronicle.v1.IGetWatchlistRequest | null | undefined, {} | null | undefined>): void;
    getWatchlist(request: protos.google.cloud.chronicle.v1.IGetWatchlistRequest, callback: Callback<protos.google.cloud.chronicle.v1.IWatchlist, protos.google.cloud.chronicle.v1.IGetWatchlistRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a watchlist for the given instance.
     * Note that there can be at most 200 watchlists per instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource where this watchlist will be created.
     *   Format: `projects/{project}/locations/{location}/instances/{instance}`
     * @param {string} [request.watchlistId]
     *   Optional. The ID to use for the watchlist,
     *   which will become the final component of the watchlist's resource name.
     *
     *   This value should be 4-63 characters, and valid characters
     *   are /{@link protos.0-9|a-z}-/.
     * @param {google.cloud.chronicle.v1.Watchlist} request.watchlist
     *   Required. The watchlist to create.
     * @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 {@link protos.google.cloud.chronicle.v1.Watchlist|Watchlist}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/entity_service.create_watchlist.js</caption>
     * region_tag:chronicle_v1_generated_EntityService_CreateWatchlist_async
     */
    createWatchlist(request?: protos.google.cloud.chronicle.v1.ICreateWatchlistRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IWatchlist,
        protos.google.cloud.chronicle.v1.ICreateWatchlistRequest | undefined,
        {} | undefined
    ]>;
    createWatchlist(request: protos.google.cloud.chronicle.v1.ICreateWatchlistRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IWatchlist, protos.google.cloud.chronicle.v1.ICreateWatchlistRequest | null | undefined, {} | null | undefined>): void;
    createWatchlist(request: protos.google.cloud.chronicle.v1.ICreateWatchlistRequest, callback: Callback<protos.google.cloud.chronicle.v1.IWatchlist, protos.google.cloud.chronicle.v1.ICreateWatchlistRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Updates the watchlist for the given instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.chronicle.v1.Watchlist} request.watchlist
     *   Required. The watchlist to update.
     *
     *   The watchlist's `name` field is used to identify the watchlist to update.
     *   Format:
     *   `projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}`
     * @param {google.protobuf.FieldMask} [request.updateMask]
     *   Optional. The list of fields to update.
     * @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 {@link protos.google.cloud.chronicle.v1.Watchlist|Watchlist}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/entity_service.update_watchlist.js</caption>
     * region_tag:chronicle_v1_generated_EntityService_UpdateWatchlist_async
     */
    updateWatchlist(request?: protos.google.cloud.chronicle.v1.IUpdateWatchlistRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IWatchlist,
        protos.google.cloud.chronicle.v1.IUpdateWatchlistRequest | undefined,
        {} | undefined
    ]>;
    updateWatchlist(request: protos.google.cloud.chronicle.v1.IUpdateWatchlistRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IWatchlist, protos.google.cloud.chronicle.v1.IUpdateWatchlistRequest | null | undefined, {} | null | undefined>): void;
    updateWatchlist(request: protos.google.cloud.chronicle.v1.IUpdateWatchlistRequest, callback: Callback<protos.google.cloud.chronicle.v1.IWatchlist, protos.google.cloud.chronicle.v1.IUpdateWatchlistRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes the watchlist for the given instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the watchlist to delete.
     *   Format:
     *   `projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}`
     * @param {boolean} [request.force]
     *   Optional. If set to true, any entities under this watchlist will also be
     *   deleted. (Otherwise, the request will only work if the watchlist has no
     *   entities.)
     * @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 {@link protos.google.protobuf.Empty|Empty}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/entity_service.delete_watchlist.js</caption>
     * region_tag:chronicle_v1_generated_EntityService_DeleteWatchlist_async
     */
    deleteWatchlist(request?: protos.google.cloud.chronicle.v1.IDeleteWatchlistRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.chronicle.v1.IDeleteWatchlistRequest | undefined,
        {} | undefined
    ]>;
    deleteWatchlist(request: protos.google.cloud.chronicle.v1.IDeleteWatchlistRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteWatchlistRequest | null | undefined, {} | null | undefined>): void;
    deleteWatchlist(request: protos.google.cloud.chronicle.v1.IDeleteWatchlistRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteWatchlistRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Lists all watchlists for the given instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent, which owns this collection of watchlists.
     *   Format: `projects/{project}/locations/{location}/instances/{instance}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of watchlists to return.
     *   The service may return fewer than this value.
     *   If unspecified, at most 200 watchlists will be returned.
     *   The maximum value is 200; values above 200 will be coerced to 200.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous `ListWatchlists` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   `ListWatchlists` must match the call that provided the page
     *   token.
     * @param {string} [request.filter]
     *   Optional. Which watchlist to return in aip.dev/160 form.
     *   Currently, only the following filters are supported:
     *   - `watchlist_user_preferences.pinned=true`
     *   - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])`
     *   - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])`
     * @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.chronicle.v1.Watchlist|Watchlist}.
     *   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 `listWatchlistsAsync()`
     *   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.
     */
    listWatchlists(request?: protos.google.cloud.chronicle.v1.IListWatchlistsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IWatchlist[],
        protos.google.cloud.chronicle.v1.IListWatchlistsRequest | null,
        protos.google.cloud.chronicle.v1.IListWatchlistsResponse
    ]>;
    listWatchlists(request: protos.google.cloud.chronicle.v1.IListWatchlistsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListWatchlistsRequest, protos.google.cloud.chronicle.v1.IListWatchlistsResponse | null | undefined, protos.google.cloud.chronicle.v1.IWatchlist>): void;
    listWatchlists(request: protos.google.cloud.chronicle.v1.IListWatchlistsRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListWatchlistsRequest, protos.google.cloud.chronicle.v1.IListWatchlistsResponse | null | undefined, protos.google.cloud.chronicle.v1.IWatchlist>): void;
    /**
     * Equivalent to `listWatchlists`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent, which owns this collection of watchlists.
     *   Format: `projects/{project}/locations/{location}/instances/{instance}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of watchlists to return.
     *   The service may return fewer than this value.
     *   If unspecified, at most 200 watchlists will be returned.
     *   The maximum value is 200; values above 200 will be coerced to 200.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous `ListWatchlists` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   `ListWatchlists` must match the call that provided the page
     *   token.
     * @param {string} [request.filter]
     *   Optional. Which watchlist to return in aip.dev/160 form.
     *   Currently, only the following filters are supported:
     *   - `watchlist_user_preferences.pinned=true`
     *   - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])`
     *   - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])`
     * @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.chronicle.v1.Watchlist|Watchlist} 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 `listWatchlistsAsync()`
     *   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.
     */
    listWatchlistsStream(request?: protos.google.cloud.chronicle.v1.IListWatchlistsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listWatchlists`, 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. The parent, which owns this collection of watchlists.
     *   Format: `projects/{project}/locations/{location}/instances/{instance}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of watchlists to return.
     *   The service may return fewer than this value.
     *   If unspecified, at most 200 watchlists will be returned.
     *   The maximum value is 200; values above 200 will be coerced to 200.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous `ListWatchlists` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   `ListWatchlists` must match the call that provided the page
     *   token.
     * @param {string} [request.filter]
     *   Optional. Which watchlist to return in aip.dev/160 form.
     *   Currently, only the following filters are supported:
     *   - `watchlist_user_preferences.pinned=true`
     *   - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])`
     *   - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])`
     * @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.chronicle.v1.Watchlist|Watchlist}. 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/v1/entity_service.list_watchlists.js</caption>
     * region_tag:chronicle_v1_generated_EntityService_ListWatchlists_async
     */
    listWatchlistsAsync(request?: protos.google.cloud.chronicle.v1.IListWatchlistsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.IWatchlist>;
    /**
     * Return a fully-qualified bigQueryExport resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @returns {string} Resource name string.
     */
    bigQueryExportPath(project: string, location: string, instance: string): string;
    /**
     * Parse the project from BigQueryExport resource.
     *
     * @param {string} bigQueryExportName
     *   A fully-qualified path representing BigQueryExport resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromBigQueryExportName(bigQueryExportName: string): string | number;
    /**
     * Parse the location from BigQueryExport resource.
     *
     * @param {string} bigQueryExportName
     *   A fully-qualified path representing BigQueryExport resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromBigQueryExportName(bigQueryExportName: string): string | number;
    /**
     * Parse the instance from BigQueryExport resource.
     *
     * @param {string} bigQueryExportName
     *   A fully-qualified path representing BigQueryExport resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromBigQueryExportName(bigQueryExportName: string): string | number;
    /**
     * Return a fully-qualified dashboardChart resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} chart
     * @returns {string} Resource name string.
     */
    dashboardChartPath(project: string, location: string, instance: string, chart: string): string;
    /**
     * Parse the project from DashboardChart resource.
     *
     * @param {string} dashboardChartName
     *   A fully-qualified path representing DashboardChart resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromDashboardChartName(dashboardChartName: string): string | number;
    /**
     * Parse the location from DashboardChart resource.
     *
     * @param {string} dashboardChartName
     *   A fully-qualified path representing DashboardChart resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromDashboardChartName(dashboardChartName: string): string | number;
    /**
     * Parse the instance from DashboardChart resource.
     *
     * @param {string} dashboardChartName
     *   A fully-qualified path representing DashboardChart resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromDashboardChartName(dashboardChartName: string): string | number;
    /**
     * Parse the chart from DashboardChart resource.
     *
     * @param {string} dashboardChartName
     *   A fully-qualified path representing DashboardChart resource.
     * @returns {string} A string representing the chart.
     */
    matchChartFromDashboardChartName(dashboardChartName: string): string | number;
    /**
     * Return a fully-qualified dashboardQuery resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} query
     * @returns {string} Resource name string.
     */
    dashboardQueryPath(project: string, location: string, instance: string, query: string): string;
    /**
     * Parse the project from DashboardQuery resource.
     *
     * @param {string} dashboardQueryName
     *   A fully-qualified path representing DashboardQuery resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromDashboardQueryName(dashboardQueryName: string): string | number;
    /**
     * Parse the location from DashboardQuery resource.
     *
     * @param {string} dashboardQueryName
     *   A fully-qualified path representing DashboardQuery resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromDashboardQueryName(dashboardQueryName: string): string | number;
    /**
     * Parse the instance from DashboardQuery resource.
     *
     * @param {string} dashboardQueryName
     *   A fully-qualified path representing DashboardQuery resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromDashboardQueryName(dashboardQueryName: string): string | number;
    /**
     * Parse the query from DashboardQuery resource.
     *
     * @param {string} dashboardQueryName
     *   A fully-qualified path representing DashboardQuery resource.
     * @returns {string} A string representing the query.
     */
    matchQueryFromDashboardQueryName(dashboardQueryName: string): string | number;
    /**
     * Return a fully-qualified dataAccessLabel resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} data_access_label
     * @returns {string} Resource name string.
     */
    dataAccessLabelPath(project: string, location: string, instance: string, dataAccessLabel: string): string;
    /**
     * Parse the project from DataAccessLabel resource.
     *
     * @param {string} dataAccessLabelName
     *   A fully-qualified path representing DataAccessLabel resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromDataAccessLabelName(dataAccessLabelName: string): string | number;
    /**
     * Parse the location from DataAccessLabel resource.
     *
     * @param {string} dataAccessLabelName
     *   A fully-qualified path representing DataAccessLabel resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromDataAccessLabelName(dataAccessLabelName: string): string | number;
    /**
     * Parse the instance from DataAccessLabel resource.
     *
     * @param {string} dataAccessLabelName
     *   A fully-qualified path representing DataAccessLabel resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromDataAccessLabelName(dataAccessLabelName: string): string | number;
    /**
     * Parse the data_access_label from DataAccessLabel resource.
     *
     * @param {string} dataAccessLabelName
     *   A fully-qualified path representing DataAccessLabel resource.
     * @returns {string} A string representing the data_access_label.
     */
    matchDataAccessLabelFromDataAccessLabelName(dataAccessLabelName: string): string | number;
    /**
     * Return a fully-qualified dataAccessScope resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} data_access_scope
     * @returns {string} Resource name string.
     */
    dataAccessScopePath(project: string, location: string, instance: string, dataAccessScope: string): string;
    /**
     * Parse the project from DataAccessScope resource.
     *
     * @param {string} dataAccessScopeName
     *   A fully-qualified path representing DataAccessScope resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromDataAccessScopeName(dataAccessScopeName: string): string | number;
    /**
     * Parse the location from DataAccessScope resource.
     *
     * @param {string} dataAccessScopeName
     *   A fully-qualified path representing DataAccessScope resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromDataAccessScopeName(dataAccessScopeName: string): string | number;
    /**
     * Parse the instance from DataAccessScope resource.
     *
     * @param {string} dataAccessScopeName
     *   A fully-qualified path representing DataAccessScope resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromDataAccessScopeName(dataAccessScopeName: string): string | number;
    /**
     * Parse the data_access_scope from DataAccessScope resource.
     *
     * @param {string} dataAccessScopeName
     *   A fully-qualified path representing DataAccessScope resource.
     * @returns {string} A string representing the data_access_scope.
     */
    matchDataAccessScopeFromDataAccessScopeName(dataAccessScopeName: string): string | number;
    /**
     * Return a fully-qualified dataTable resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} data_table
     * @returns {string} Resource name string.
     */
    dataTablePath(project: string, location: string, instance: string, dataTable: string): string;
    /**
     * Parse the project from DataTable resource.
     *
     * @param {string} dataTableName
     *   A fully-qualified path representing DataTable resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromDataTableName(dataTableName: string): string | number;
    /**
     * Parse the location from DataTable resource.
     *
     * @param {string} dataTableName
     *   A fully-qualified path representing DataTable resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromDataTableName(dataTableName: string): string | number;
    /**
     * Parse the instance from DataTable resource.
     *
     * @param {string} dataTableName
     *   A fully-qualified path representing DataTable resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromDataTableName(dataTableName: string): string | number;
    /**
     * Parse the data_table from DataTable resource.
     *
     * @param {string} dataTableName
     *   A fully-qualified path representing DataTable resource.
     * @returns {string} A string representing the data_table.
     */
    matchDataTableFromDataTableName(dataTableName: string): string | number;
    /**
     * Return a fully-qualified dataTableOperationErrors resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} data_table_operation_errors
     * @returns {string} Resource name string.
     */
    dataTableOperationErrorsPath(project: string, location: string, instance: string, dataTableOperationErrors: string): string;
    /**
     * Parse the project from DataTableOperationErrors resource.
     *
     * @param {string} dataTableOperationErrorsName
     *   A fully-qualified path representing DataTableOperationErrors resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromDataTableOperationErrorsName(dataTableOperationErrorsName: string): string | number;
    /**
     * Parse the location from DataTableOperationErrors resource.
     *
     * @param {string} dataTableOperationErrorsName
     *   A fully-qualified path representing DataTableOperationErrors resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromDataTableOperationErrorsName(dataTableOperationErrorsName: string): string | number;
    /**
     * Parse the instance from DataTableOperationErrors resource.
     *
     * @param {string} dataTableOperationErrorsName
     *   A fully-qualified path representing DataTableOperationErrors resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromDataTableOperationErrorsName(dataTableOperationErrorsName: string): string | number;
    /**
     * Parse the data_table_operation_errors from DataTableOperationErrors resource.
     *
     * @param {string} dataTableOperationErrorsName
     *   A fully-qualified path representing DataTableOperationErrors resource.
     * @returns {string} A string representing the data_table_operation_errors.
     */
    matchDataTableOperationErrorsFromDataTableOperationErrorsName(dataTableOperationErrorsName: string): string | number;
    /**
     * Return a fully-qualified dataTableRow resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} data_table
     * @param {string} data_table_row
     * @returns {string} Resource name string.
     */
    dataTableRowPath(project: string, location: string, instance: string, dataTable: string, dataTableRow: string): string;
    /**
     * Parse the project from DataTableRow resource.
     *
     * @param {string} dataTableRowName
     *   A fully-qualified path representing DataTableRow resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromDataTableRowName(dataTableRowName: string): string | number;
    /**
     * Parse the location from DataTableRow resource.
     *
     * @param {string} dataTableRowName
     *   A fully-qualified path representing DataTableRow resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromDataTableRowName(dataTableRowName: string): string | number;
    /**
     * Parse the instance from DataTableRow resource.
     *
     * @param {string} dataTableRowName
     *   A fully-qualified path representing DataTableRow resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromDataTableRowName(dataTableRowName: string): string | number;
    /**
     * Parse the data_table from DataTableRow resource.
     *
     * @param {string} dataTableRowName
     *   A fully-qualified path representing DataTableRow resource.
     * @returns {string} A string representing the data_table.
     */
    matchDataTableFromDataTableRowName(dataTableRowName: string): string | number;
    /**
     * Parse the data_table_row from DataTableRow resource.
     *
     * @param {string} dataTableRowName
     *   A fully-qualified path representing DataTableRow resource.
     * @returns {string} A string representing the data_table_row.
     */
    matchDataTableRowFromDataTableRowName(dataTableRowName: string): string | number;
    /**
     * Return a fully-qualified featuredContentNativeDashboard resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} featured_content_native_dashboard
     * @returns {string} Resource name string.
     */
    featuredContentNativeDashboardPath(project: string, location: string, instance: string, featuredContentNativeDashboard: string): string;
    /**
     * Parse the project from FeaturedContentNativeDashboard resource.
     *
     * @param {string} featuredContentNativeDashboardName
     *   A fully-qualified path representing FeaturedContentNativeDashboard resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName: string): string | number;
    /**
     * Parse the location from FeaturedContentNativeDashboard resource.
     *
     * @param {string} featuredContentNativeDashboardName
     *   A fully-qualified path representing FeaturedContentNativeDashboard resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName: string): string | number;
    /**
     * Parse the instance from FeaturedContentNativeDashboard resource.
     *
     * @param {string} featuredContentNativeDashboardName
     *   A fully-qualified path representing FeaturedContentNativeDashboard resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName: string): string | number;
    /**
     * Parse the featured_content_native_dashboard from FeaturedContentNativeDashboard resource.
     *
     * @param {string} featuredContentNativeDashboardName
     *   A fully-qualified path representing FeaturedContentNativeDashboard resource.
     * @returns {string} A string representing the featured_content_native_dashboard.
     */
    matchFeaturedContentNativeDashboardFromFeaturedContentNativeDashboardName(featuredContentNativeDashboardName: string): string | number;
    /**
     * Return a fully-qualified instance resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @returns {string} Resource name string.
     */
    instancePath(project: string, location: string, instance: string): string;
    /**
     * Parse the project from Instance resource.
     *
     * @param {string} instanceName
     *   A fully-qualified path representing Instance resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromInstanceName(instanceName: string): string | number;
    /**
     * Parse the location from Instance resource.
     *
     * @param {string} instanceName
     *   A fully-qualified path representing Instance resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromInstanceName(instanceName: string): string | number;
    /**
     * Parse the instance from Instance resource.
     *
     * @param {string} instanceName
     *   A fully-qualified path representing Instance resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromInstanceName(instanceName: string): string | number;
    /**
     * Return a fully-qualified location resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @returns {string} Resource name string.
     */
    locationPath(project: string, location: string): string;
    /**
     * Parse the project from Location resource.
     *
     * @param {string} locationName
     *   A fully-qualified path representing Location resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromLocationName(locationName: string): string | number;
    /**
     * Parse the location from Location resource.
     *
     * @param {string} locationName
     *   A fully-qualified path representing Location resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromLocationName(locationName: string): string | number;
    /**
     * Return a fully-qualified nativeDashboard resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} dashboard
     * @returns {string} Resource name string.
     */
    nativeDashboardPath(project: string, location: string, instance: string, dashboard: string): string;
    /**
     * Parse the project from NativeDashboard resource.
     *
     * @param {string} nativeDashboardName
     *   A fully-qualified path representing NativeDashboard resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromNativeDashboardName(nativeDashboardName: string): string | number;
    /**
     * Parse the location from NativeDashboard resource.
     *
     * @param {string} nativeDashboardName
     *   A fully-qualified path representing NativeDashboard resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromNativeDashboardName(nativeDashboardName: string): string | number;
    /**
     * Parse the instance from NativeDashboard resource.
     *
     * @param {string} nativeDashboardName
     *   A fully-qualified path representing NativeDashboard resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromNativeDashboardName(nativeDashboardName: string): string | number;
    /**
     * Parse the dashboard from NativeDashboard resource.
     *
     * @param {string} nativeDashboardName
     *   A fully-qualified path representing NativeDashboard resource.
     * @returns {string} A string representing the dashboard.
     */
    matchDashboardFromNativeDashboardName(nativeDashboardName: string): string | number;
    /**
     * Return a fully-qualified project resource name string.
     *
     * @param {string} project
     * @returns {string} Resource name string.
     */
    projectPath(project: string): string;
    /**
     * Parse the project from Project resource.
     *
     * @param {string} projectName
     *   A fully-qualified path representing Project resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromProjectName(projectName: string): string | number;
    /**
     * Return a fully-qualified referenceList resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} reference_list
     * @returns {string} Resource name string.
     */
    referenceListPath(project: string, location: string, instance: string, referenceList: string): string;
    /**
     * Parse the project from ReferenceList resource.
     *
     * @param {string} referenceListName
     *   A fully-qualified path representing ReferenceList resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromReferenceListName(referenceListName: string): string | number;
    /**
     * Parse the location from ReferenceList resource.
     *
     * @param {string} referenceListName
     *   A fully-qualified path representing ReferenceList resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromReferenceListName(referenceListName: string): string | number;
    /**
     * Parse the instance from ReferenceList resource.
     *
     * @param {string} referenceListName
     *   A fully-qualified path representing ReferenceList resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromReferenceListName(referenceListName: string): string | number;
    /**
     * Parse the reference_list from ReferenceList resource.
     *
     * @param {string} referenceListName
     *   A fully-qualified path representing ReferenceList resource.
     * @returns {string} A string representing the reference_list.
     */
    matchReferenceListFromReferenceListName(referenceListName: string): string | number;
    /**
     * Return a fully-qualified retrohunt resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} rule
     * @param {string} retrohunt
     * @returns {string} Resource name string.
     */
    retrohuntPath(project: string, location: string, instance: string, rule: string, retrohunt: string): string;
    /**
     * Parse the project from Retrohunt resource.
     *
     * @param {string} retrohuntName
     *   A fully-qualified path representing Retrohunt resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromRetrohuntName(retrohuntName: string): string | number;
    /**
     * Parse the location from Retrohunt resource.
     *
     * @param {string} retrohuntName
     *   A fully-qualified path representing Retrohunt resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromRetrohuntName(retrohuntName: string): string | number;
    /**
     * Parse the instance from Retrohunt resource.
     *
     * @param {string} retrohuntName
     *   A fully-qualified path representing Retrohunt resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromRetrohuntName(retrohuntName: string): string | number;
    /**
     * Parse the rule from Retrohunt resource.
     *
     * @param {string} retrohuntName
     *   A fully-qualified path representing Retrohunt resource.
     * @returns {string} A string representing the rule.
     */
    matchRuleFromRetrohuntName(retrohuntName: string): string | number;
    /**
     * Parse the retrohunt from Retrohunt resource.
     *
     * @param {string} retrohuntName
     *   A fully-qualified path representing Retrohunt resource.
     * @returns {string} A string representing the retrohunt.
     */
    matchRetrohuntFromRetrohuntName(retrohuntName: string): string | number;
    /**
     * Return a fully-qualified rule resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} rule
     * @returns {string} Resource name string.
     */
    rulePath(project: string, location: string, instance: string, rule: string): string;
    /**
     * Parse the project from Rule resource.
     *
     * @param {string} ruleName
     *   A fully-qualified path representing Rule resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromRuleName(ruleName: string): string | number;
    /**
     * Parse the location from Rule resource.
     *
     * @param {string} ruleName
     *   A fully-qualified path representing Rule resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromRuleName(ruleName: string): string | number;
    /**
     * Parse the instance from Rule resource.
     *
     * @param {string} ruleName
     *   A fully-qualified path representing Rule resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromRuleName(ruleName: string): string | number;
    /**
     * Parse the rule from Rule resource.
     *
     * @param {string} ruleName
     *   A fully-qualified path representing Rule resource.
     * @returns {string} A string representing the rule.
     */
    matchRuleFromRuleName(ruleName: string): string | number;
    /**
     * Return a fully-qualified ruleDeployment resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} rule
     * @returns {string} Resource name string.
     */
    ruleDeploymentPath(project: string, location: string, instance: string, rule: string): string;
    /**
     * Parse the project from RuleDeployment resource.
     *
     * @param {string} ruleDeploymentName
     *   A fully-qualified path representing RuleDeployment resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromRuleDeploymentName(ruleDeploymentName: string): string | number;
    /**
     * Parse the location from RuleDeployment resource.
     *
     * @param {string} ruleDeploymentName
     *   A fully-qualified path representing RuleDeployment resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromRuleDeploymentName(ruleDeploymentName: string): string | number;
    /**
     * Parse the instance from RuleDeployment resource.
     *
     * @param {string} ruleDeploymentName
     *   A fully-qualified path representing RuleDeployment resource.
     * @returns {string} A string representing the instance.
     */
    matchInstanceFromRuleDeploymentName(ruleDeploymentName: string): string | number;
    /**
     * Parse the rule from RuleDeployment resource.
     *
     * @param {string} ruleDeploymentName
     *   A fully-qualified path representing RuleDeployment resource.
     * @returns {string} A string representing the rule.
     */
    matchRuleFromRuleDeploymentName(ruleDeploymentName: string): string | number;
    /**
     * Return a fully-qualified ruleExecutionError resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} instance
     * @param {string} rule_execution_error
     * @returns {string} Resource name string.
     */
    ruleExecutionErrorPath(project: string, location: string, instance: string, ruleExecutionError: string): string;
    /**
     * Parse the project from RuleExecutionError resource.
     *
     * @param {string} ruleExecutionErrorName
     *   A fully-qualified path representing RuleExecutionError resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromRuleExecutionErrorName(ruleExecutionEr