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

Chronicle API client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
import * as protos from '../../protos/protos';
/**
 *  InstanceService provides the entry interface for the Chronicle API.
 * @class
 * @memberof v1
 */
export declare class InstanceServiceClient {
    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;
    };
    instanceServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of InstanceServiceClient.
     *
     * @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 InstanceServiceClient({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 Instance.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the instance to retrieve.
     *   Format:
     *   `projects/{project_id}/locations/{location}/instances/{instance}`
     * @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.Instance|Instance}.
     *   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/instance_service.get_instance.js</caption>
     * region_tag:chronicle_v1_generated_InstanceService_GetInstance_async
     */
    getInstance(request?: protos.google.cloud.chronicle.v1.IGetInstanceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.chronicle.v1.IInstance,
        protos.google.cloud.chronicle.v1.IGetInstanceRequest | undefined,
        {} | undefined
    ]>;
    getInstance(request: protos.google.cloud.chronicle.v1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IInstance, protos.google.cloud.chronicle.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
    getInstance(request: protos.google.cloud.chronicle.v1.IGetInstanceRequest, callback: Callback<protos.google.cloud.chronicle.v1.IInstance, protos.google.cloud.chronicle.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
    /**
     * 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 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>;
}