UNPKG

@google-cloud/chronicle

Version:
704 lines (703 loc) 34.9 kB
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'; /** * ReferenceListService provides an interface for managing reference lists. * @class * @memberof v1 */ export declare class ReferenceListServiceClient { 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; }; referenceListServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ReferenceListServiceClient. * * @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 ReferenceListServiceClient({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 a single reference list. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the reference list to retrieve. * Format: * `projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}` * @param {google.cloud.chronicle.v1.ReferenceListView} request.view * How much of the ReferenceList to view. Defaults to * REFERENCE_LIST_VIEW_FULL. * @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.ReferenceList|ReferenceList}. * 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/reference_list_service.get_reference_list.js</caption> * region_tag:chronicle_v1_generated_ReferenceListService_GetReferenceList_async */ getReferenceList(request?: protos.google.cloud.chronicle.v1.IGetReferenceListRequest, options?: CallOptions): Promise<[ protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.IGetReferenceListRequest | undefined, {} | undefined ]>; getReferenceList(request: protos.google.cloud.chronicle.v1.IGetReferenceListRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.IGetReferenceListRequest | null | undefined, {} | null | undefined>): void; getReferenceList(request: protos.google.cloud.chronicle.v1.IGetReferenceListRequest, callback: Callback<protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.IGetReferenceListRequest | null | undefined, {} | null | undefined>): void; /** * Creates a new reference list. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource where this reference list will be created. * Format: `projects/{project}/locations/{location}/instances/{instance}` * @param {google.cloud.chronicle.v1.ReferenceList} request.referenceList * Required. The reference list to create. * @param {string} request.referenceListId * Required. The ID to use for the reference list. This is also the display * name for the reference list. It must satisfy the following requirements: * - Starts with letter. * - Contains only letters, numbers and underscore. * - Has length less than 256. * - Must be unique. * @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.ReferenceList|ReferenceList}. * 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/reference_list_service.create_reference_list.js</caption> * region_tag:chronicle_v1_generated_ReferenceListService_CreateReferenceList_async */ createReferenceList(request?: protos.google.cloud.chronicle.v1.ICreateReferenceListRequest, options?: CallOptions): Promise<[ protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.ICreateReferenceListRequest | undefined, {} | undefined ]>; createReferenceList(request: protos.google.cloud.chronicle.v1.ICreateReferenceListRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.ICreateReferenceListRequest | null | undefined, {} | null | undefined>): void; createReferenceList(request: protos.google.cloud.chronicle.v1.ICreateReferenceListRequest, callback: Callback<protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.ICreateReferenceListRequest | null | undefined, {} | null | undefined>): void; /** * Updates an existing reference list. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.chronicle.v1.ReferenceList} request.referenceList * Required. The reference list to update. * * The reference list's `name` field is used to identify the reference list to * update. * Format: * `projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}` * @param {google.protobuf.FieldMask} request.updateMask * The list of fields to update. * When no field mask is supplied, all non-empty fields will be updated. * A field mask of "*" will update all fields, whether empty or not. * @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.ReferenceList|ReferenceList}. * 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/reference_list_service.update_reference_list.js</caption> * region_tag:chronicle_v1_generated_ReferenceListService_UpdateReferenceList_async */ updateReferenceList(request?: protos.google.cloud.chronicle.v1.IUpdateReferenceListRequest, options?: CallOptions): Promise<[ protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.IUpdateReferenceListRequest | undefined, {} | undefined ]>; updateReferenceList(request: protos.google.cloud.chronicle.v1.IUpdateReferenceListRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.IUpdateReferenceListRequest | null | undefined, {} | null | undefined>): void; updateReferenceList(request: protos.google.cloud.chronicle.v1.IUpdateReferenceListRequest, callback: Callback<protos.google.cloud.chronicle.v1.IReferenceList, protos.google.cloud.chronicle.v1.IUpdateReferenceListRequest | null | undefined, {} | null | undefined>): void; /** * Lists a collection of reference lists. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent, which owns this collection of reference lists. * Format: * `projects/{project}/locations/{location}/instances/{instance}` * @param {number} request.pageSize * The maximum number of reference lists to return. * The service may return fewer than this value. * If unspecified, at most 100 reference lists will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListReferenceLists` call. * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListReferenceLists` must * match the call that provided the page token. * @param {google.cloud.chronicle.v1.ReferenceListView} request.view * How much of each ReferenceList to view. Defaults to * REFERENCE_LIST_VIEW_BASIC. * @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.ReferenceList|ReferenceList}. * 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 `listReferenceListsAsync()` * 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. */ listReferenceLists(request?: protos.google.cloud.chronicle.v1.IListReferenceListsRequest, options?: CallOptions): Promise<[ protos.google.cloud.chronicle.v1.IReferenceList[], protos.google.cloud.chronicle.v1.IListReferenceListsRequest | null, protos.google.cloud.chronicle.v1.IListReferenceListsResponse ]>; listReferenceLists(request: protos.google.cloud.chronicle.v1.IListReferenceListsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListReferenceListsRequest, protos.google.cloud.chronicle.v1.IListReferenceListsResponse | null | undefined, protos.google.cloud.chronicle.v1.IReferenceList>): void; listReferenceLists(request: protos.google.cloud.chronicle.v1.IListReferenceListsRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListReferenceListsRequest, protos.google.cloud.chronicle.v1.IListReferenceListsResponse | null | undefined, protos.google.cloud.chronicle.v1.IReferenceList>): void; /** * Equivalent to `listReferenceLists`, 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 reference lists. * Format: * `projects/{project}/locations/{location}/instances/{instance}` * @param {number} request.pageSize * The maximum number of reference lists to return. * The service may return fewer than this value. * If unspecified, at most 100 reference lists will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListReferenceLists` call. * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListReferenceLists` must * match the call that provided the page token. * @param {google.cloud.chronicle.v1.ReferenceListView} request.view * How much of each ReferenceList to view. Defaults to * REFERENCE_LIST_VIEW_BASIC. * @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.ReferenceList|ReferenceList} 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 `listReferenceListsAsync()` * 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. */ listReferenceListsStream(request?: protos.google.cloud.chronicle.v1.IListReferenceListsRequest, options?: CallOptions): Transform; /** * Equivalent to `listReferenceLists`, 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 reference lists. * Format: * `projects/{project}/locations/{location}/instances/{instance}` * @param {number} request.pageSize * The maximum number of reference lists to return. * The service may return fewer than this value. * If unspecified, at most 100 reference lists will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListReferenceLists` call. * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListReferenceLists` must * match the call that provided the page token. * @param {google.cloud.chronicle.v1.ReferenceListView} request.view * How much of each ReferenceList to view. Defaults to * REFERENCE_LIST_VIEW_BASIC. * @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.ReferenceList|ReferenceList}. 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/reference_list_service.list_reference_lists.js</caption> * region_tag:chronicle_v1_generated_ReferenceListService_ListReferenceLists_async */ listReferenceListsAsync(request?: protos.google.cloud.chronicle.v1.IListReferenceListsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.IReferenceList>; /** * 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 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 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 watchlist resource name string. * * @param {string} project * @param {string} location * @param {string} instance * @param {string} watchlist * @returns {string} Resource name string. */ watchlistPath(project: string, location: string, instance: string, watchlist: string): string; /** * Parse the project from Watchlist resource. * * @param {string} watchlistName * A fully-qualified path representing Watchlist resource. * @returns {string} A string representing the project. */ matchProjectFromWatchlistName(watchlistName: string): string | number; /** * Parse the location from Watchlist resource. * * @param {string} watchlistName * A fully-qualified path representing Watchlist resource. * @returns {string} A string representing the location. */ matchLocationFromWatchlistName(watchlistName: string): string | number; /** * Parse the instance from Watchlist resource. * * @param {string} watchlistName * A fully-qualified path representing Watchlist resource. * @returns {string} A string representing the instance. */ matchInstanceFromWatchlistName(watchlistName: string): string | number; /** * Parse the watchlist from Watchlist resource. * * @param {string} watchlistName * A fully-qualified path representing Watchlist resource. * @returns {string} A string representing the watchlist. */ matchWatchlistFromWatchlistName(watchlistName: 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>; }