@google-cloud/dialogflow-cx/build/src/v3/tools_client.d.ts

Cx client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Service for managing {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tools}.
 * @class
 * @memberof v3
 */
export declare class ToolsClient {
    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;
    };
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    toolsStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of ToolsClient.
     *
     * @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 ToolsClient({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;
    /**
     * Creates a {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tool} in the specified
     * agent.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent to create a Tool for.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {google.cloud.dialogflow.cx.v3.Tool} request.tool
     *   Required. The Tool to be created.
     * @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.dialogflow.cx.v3.Tool|Tool}.
     *   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/v3/tools.create_tool.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_CreateTool_async
     */
    createTool(request?: protos.google.cloud.dialogflow.cx.v3.ICreateToolRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITool,
        protos.google.cloud.dialogflow.cx.v3.ICreateToolRequest | undefined,
        {} | undefined
    ]>;
    createTool(request: protos.google.cloud.dialogflow.cx.v3.ICreateToolRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITool, protos.google.cloud.dialogflow.cx.v3.ICreateToolRequest | null | undefined, {} | null | undefined>): void;
    createTool(request: protos.google.cloud.dialogflow.cx.v3.ICreateToolRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITool, protos.google.cloud.dialogflow.cx.v3.ICreateToolRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Retrieves the specified {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tool}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the Tool.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
     * @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.dialogflow.cx.v3.Tool|Tool}.
     *   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/v3/tools.get_tool.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_GetTool_async
     */
    getTool(request?: protos.google.cloud.dialogflow.cx.v3.IGetToolRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITool,
        protos.google.cloud.dialogflow.cx.v3.IGetToolRequest | undefined,
        {} | undefined
    ]>;
    getTool(request: protos.google.cloud.dialogflow.cx.v3.IGetToolRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITool, protos.google.cloud.dialogflow.cx.v3.IGetToolRequest | null | undefined, {} | null | undefined>): void;
    getTool(request: protos.google.cloud.dialogflow.cx.v3.IGetToolRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITool, protos.google.cloud.dialogflow.cx.v3.IGetToolRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Update the specified {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tool}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.dialogflow.cx.v3.Tool} request.tool
     *   Required. The Tool to be updated.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   The mask to control which fields get updated. If the mask is not present,
     *   all fields will be updated.
     * @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.dialogflow.cx.v3.Tool|Tool}.
     *   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/v3/tools.update_tool.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_UpdateTool_async
     */
    updateTool(request?: protos.google.cloud.dialogflow.cx.v3.IUpdateToolRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITool,
        protos.google.cloud.dialogflow.cx.v3.IUpdateToolRequest | undefined,
        {} | undefined
    ]>;
    updateTool(request: protos.google.cloud.dialogflow.cx.v3.IUpdateToolRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITool, protos.google.cloud.dialogflow.cx.v3.IUpdateToolRequest | null | undefined, {} | null | undefined>): void;
    updateTool(request: protos.google.cloud.dialogflow.cx.v3.IUpdateToolRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITool, protos.google.cloud.dialogflow.cx.v3.IUpdateToolRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes a specified {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tool}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the Tool to be deleted.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
     * @param {boolean} request.force
     *   This field has no effect for Tools not being used.
     *   For Tools that are used:
     *
     *   *  If `force` is set to false, an error will be returned with message
     *      indicating the referenced resources.
     *   *  If `force` is set to true, Dialogflow will remove the tool, as well
     *      as any references to the tool.
     * @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/v3/tools.delete_tool.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_DeleteTool_async
     */
    deleteTool(request?: protos.google.cloud.dialogflow.cx.v3.IDeleteToolRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.cx.v3.IDeleteToolRequest | undefined,
        {} | undefined
    ]>;
    deleteTool(request: protos.google.cloud.dialogflow.cx.v3.IDeleteToolRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteToolRequest | null | undefined, {} | null | undefined>): void;
    deleteTool(request: protos.google.cloud.dialogflow.cx.v3.IDeleteToolRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteToolRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a version for the specified
     * {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tool}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The tool to create a version for.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
     * @param {google.cloud.dialogflow.cx.v3.ToolVersion} request.toolVersion
     *   Required. The tool version 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.dialogflow.cx.v3.ToolVersion|ToolVersion}.
     *   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/v3/tools.create_tool_version.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_CreateToolVersion_async
     */
    createToolVersion(request?: protos.google.cloud.dialogflow.cx.v3.ICreateToolVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IToolVersion,
        protos.google.cloud.dialogflow.cx.v3.ICreateToolVersionRequest | undefined,
        {} | undefined
    ]>;
    createToolVersion(request: protos.google.cloud.dialogflow.cx.v3.ICreateToolVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IToolVersion, protos.google.cloud.dialogflow.cx.v3.ICreateToolVersionRequest | null | undefined, {} | null | undefined>): void;
    createToolVersion(request: protos.google.cloud.dialogflow.cx.v3.ICreateToolVersionRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IToolVersion, protos.google.cloud.dialogflow.cx.v3.ICreateToolVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Retrieves the specified version of the
     * {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tool}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the tool version.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>`.
     * @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.dialogflow.cx.v3.ToolVersion|ToolVersion}.
     *   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/v3/tools.get_tool_version.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_GetToolVersion_async
     */
    getToolVersion(request?: protos.google.cloud.dialogflow.cx.v3.IGetToolVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IToolVersion,
        protos.google.cloud.dialogflow.cx.v3.IGetToolVersionRequest | undefined,
        {} | undefined
    ]>;
    getToolVersion(request: protos.google.cloud.dialogflow.cx.v3.IGetToolVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IToolVersion, protos.google.cloud.dialogflow.cx.v3.IGetToolVersionRequest | null | undefined, {} | null | undefined>): void;
    getToolVersion(request: protos.google.cloud.dialogflow.cx.v3.IGetToolVersionRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IToolVersion, protos.google.cloud.dialogflow.cx.v3.IGetToolVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes the specified version of the
     * {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tool}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the tool version to delete.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>`.
     * @param {boolean} [request.force]
     *   Optional. This field has no effect for Tools not being used.
     *   For Tools that are used:
     *
     *   *  If `force` is set to false, an error will be returned with message
     *      indicating the referenced resources.
     *   *  If `force` is set to true, Dialogflow will remove the tool, as well
     *      as any references to the tool.
     * @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/v3/tools.delete_tool_version.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_DeleteToolVersion_async
     */
    deleteToolVersion(request?: protos.google.cloud.dialogflow.cx.v3.IDeleteToolVersionRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.cx.v3.IDeleteToolVersionRequest | undefined,
        {} | undefined
    ]>;
    deleteToolVersion(request: protos.google.cloud.dialogflow.cx.v3.IDeleteToolVersionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteToolVersionRequest | null | undefined, {} | null | undefined>): void;
    deleteToolVersion(request: protos.google.cloud.dialogflow.cx.v3.IDeleteToolVersionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteToolVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Retrieves the specified version of the Tool and stores it as the
     * current tool draft, returning the tool with resources updated.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the tool version.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>/versions/<VersionID>`.
     * @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.dialogflow.cx.v3.RestoreToolVersionResponse|RestoreToolVersionResponse}.
     *   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/v3/tools.restore_tool_version.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_RestoreToolVersion_async
     */
    restoreToolVersion(request?: protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionResponse,
        protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionRequest | undefined,
        {} | undefined
    ]>;
    restoreToolVersion(request: protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionResponse, protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionRequest | null | undefined, {} | null | undefined>): void;
    restoreToolVersion(request: protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionResponse, protos.google.cloud.dialogflow.cx.v3.IRestoreToolVersionRequest | null | undefined, {} | null | undefined>): void;
    /**
    * Returns a list of {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tools} in the
    * specified agent.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The agent to list the Tools from.
    *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
    * @param {number} request.pageSize
    *   The maximum number of items to return in a single page. By default 100 and
    *   at most 1000.
    * @param {string} request.pageToken
    *   The next_page_token value returned from a previous list request.
    * @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.dialogflow.cx.v3.Tool|Tool}.
    *   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 `listToolsAsync()`
    *   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.
    */
    listTools(request?: protos.google.cloud.dialogflow.cx.v3.IListToolsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITool[],
        protos.google.cloud.dialogflow.cx.v3.IListToolsRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListToolsResponse
    ]>;
    listTools(request: protos.google.cloud.dialogflow.cx.v3.IListToolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListToolsRequest, protos.google.cloud.dialogflow.cx.v3.IListToolsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.ITool>): void;
    listTools(request: protos.google.cloud.dialogflow.cx.v3.IListToolsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListToolsRequest, protos.google.cloud.dialogflow.cx.v3.IListToolsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.ITool>): void;
    /**
     * Equivalent to `listTools`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The agent to list the Tools from.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {number} request.pageSize
     *   The maximum number of items to return in a single page. By default 100 and
     *   at most 1000.
     * @param {string} request.pageToken
     *   The next_page_token value returned from a previous list request.
     * @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.dialogflow.cx.v3.Tool|Tool} 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 `listToolsAsync()`
     *   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.
     */
    listToolsStream(request?: protos.google.cloud.dialogflow.cx.v3.IListToolsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listTools`, 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 agent to list the Tools from.
     *   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {number} request.pageSize
     *   The maximum number of items to return in a single page. By default 100 and
     *   at most 1000.
     * @param {string} request.pageToken
     *   The next_page_token value returned from a previous list request.
     * @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.dialogflow.cx.v3.Tool|Tool}. 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/v3/tools.list_tools.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_ListTools_async
     */
    listToolsAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListToolsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.ITool>;
    /**
    * List versions of the specified {@link protos.google.cloud.dialogflow.cx.v3.Tool|Tool}.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The parent of the tool versions.
    *   Format:
    *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of items to return in a single page. By
    *   default 100 and at most 1000.
    * @param {string} [request.pageToken]
    *   Optional. The next_page_token value returned from a previous list request.
    * @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.dialogflow.cx.v3.ToolVersion|ToolVersion}.
    *   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 `listToolVersionsAsync()`
    *   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.
    */
    listToolVersions(request?: protos.google.cloud.dialogflow.cx.v3.IListToolVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IToolVersion[],
        protos.google.cloud.dialogflow.cx.v3.IListToolVersionsRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListToolVersionsResponse
    ]>;
    listToolVersions(request: protos.google.cloud.dialogflow.cx.v3.IListToolVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListToolVersionsRequest, protos.google.cloud.dialogflow.cx.v3.IListToolVersionsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IToolVersion>): void;
    listToolVersions(request: protos.google.cloud.dialogflow.cx.v3.IListToolVersionsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListToolVersionsRequest, protos.google.cloud.dialogflow.cx.v3.IListToolVersionsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IToolVersion>): void;
    /**
     * Equivalent to `listToolVersions`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent of the tool versions.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of items to return in a single page. By
     *   default 100 and at most 1000.
     * @param {string} [request.pageToken]
     *   Optional. The next_page_token value returned from a previous list request.
     * @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.dialogflow.cx.v3.ToolVersion|ToolVersion} 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 `listToolVersionsAsync()`
     *   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.
     */
    listToolVersionsStream(request?: protos.google.cloud.dialogflow.cx.v3.IListToolVersionsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listToolVersions`, 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 of the tool versions.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of items to return in a single page. By
     *   default 100 and at most 1000.
     * @param {string} [request.pageToken]
     *   Optional. The next_page_token value returned from a previous list request.
     * @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.dialogflow.cx.v3.ToolVersion|ToolVersion}. 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/v3/tools.list_tool_versions.js</caption>
     * region_tag:dialogflow_v3_generated_Tools_ListToolVersions_async
     */
    listToolVersionsAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListToolVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IToolVersion>;
    /**
       * Gets information about a location.
       *
       * @param {Object} request
       *   The request object that will be sent.
       * @param {string} request.name
       *   Resource name for the location.
       * @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 google.cloud.location.Location | Location}.
       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
       *   for more details and examples.
       * @example
       * ```
       * const [response] = await client.getLocation(request);
       * ```
       */
    getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
    /**
       * Lists information about the supported locations for this service. 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.name
       *   The resource that owns the locations collection, if applicable.
       * @param {string} request.filter
       *   The standard list filter.
       * @param {number} request.pageSize
       *   The standard list page size.
       * @param {string} request.pageToken
       *   The standard list page token.
       * @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 google.cloud.location.Location | Location}. 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
       * ```
       * const iterable = client.listLocationsAsync(request);
       * for await (const response of iterable) {
       *   // process response
       * }
       * ```
       */
    listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
    /**
       * Gets the latest state of a long-running operation.  Clients can use this
       * method to poll the operation result at intervals as recommended by the API
       * service.
       *
       * @param {Object} request - The request object that will be sent.
       * @param {string} request.name - The name of the operation resource.
       * @param {Object=} options
       *   Optional parameters. You can override the default settings for this call,
       *   e.g, timeout, retries, paginations, etc. See {@link
       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
       *   for the details.
       * @param {function(?Error, ?Object)=} callback
       *   The function which will be called with the result of the API call.
       *
       *   The second parameter to the callback is an object representing
       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
       * @return {Promise} - The promise which resolves to an array.
       *   The first element of the array is an object representing
       * {@link google.longrunning.Operation | google.longrunning.Operation}.
       * The promise has a method named "cancel" which cancels the ongoing API call.
       *
       * @example
       * ```
       * const client = longrunning.operationsClient();
       * const name = '';
       * const [response] = await client.getOperation({name});
       * // doThingsWith(response)
       * ```
       */
    getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
    /**
     * Lists operations that match the specified filter in the request. If the
     * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
     *
     * For-await-of syntax is used with the iterable to recursively get response element on-demand.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation collection.
     * @param {string} request.filter - The standard list filter.
     * @param {number=} request.pageSize -
     *   The maximum number of resources contained in the underlying API
     *   response. If page streaming is performed per-resource, this
     *   parameter does not affect the return value. If page streaming is
     *   performed per-page, this determines the maximum number of
     *   resources in a page.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     *   e.g, timeout, retries, paginations, etc. See {@link
     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
     *   details.
     * @returns {Object}
     *   An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * for await (const response of client.listOperationsAsync(request));
     * // doThingsWith(response)
     * ```
     */
    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
    /**
     * Starts asynchronous cancellation on a long-running operation.  The server
     * makes a best effort to cancel the operation, but success is not
     * guaranteed.  If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
     * {@link Operations.GetOperation} or
     * other methods to check whether the cancellation succeeded or whether the
     * operation completed despite cancellation. On successful cancellation,
     * the operation is not deleted; instead, it becomes an operation with
     * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
     * 1, corresponding to `Code.CANCELLED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be cancelled.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     * e.g, timeout, retries, paginations, etc. See {@link
     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
     * details.
     * @param {function(?Error)=} callback
     *   The function which will be called with the result of the API call.
     * @return {Promise} - The promise which resolves when API call finishes.
     *   The promise has a method named "cancel" which cancels the ongoing API
     * call.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * await client.cancelOperation({name: ''});
     * ```
     */
    cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
    /**
     * Deletes a long-running operation. This method indicates that the client is
     * no longer interested in the operation result. It does not cancel the
     * operation. If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be deleted.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     * e.g, timeout, retries, paginations, etc. See {@link
     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
     * for the details.
     * @param {function(?Error)=} callback
     *   The function which will be called with the result of the API call.
     * @return {Promise} - The promise which resolves when API call finishes.
     *   The promise has a method named "cancel" which cancels the ongoing API
     * call.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * await client.deleteOperation({name: ''});
     * ```
     */
    deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
    /**
     * Return a fully-qualified agent resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @returns {string} Resource name string.
     */
    agentPath(project: string, location: string, agent: string): string;
    /**
     * Parse the project from Agent resource.
     *
     * @param {string} agentName
     *   A fully-qualified path representing Agent resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromAgentName(agentName: string): string | number;
    /**
     * Parse the location from Agent resource.
     *
     * @param {string} agentName
     *   A fully-qualified path representing Agent resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromAgentName(agentName: string): string | number;
    /**
     * Parse the agent from Agent resource.
     *
     * @param {string} agentName
     *   A fully-qualified path representing Agent resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromAgentName(agentName: string): string | number;
    /**
     * Return a fully-qualified agentGenerativeSettings resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @returns {string} Resource name string.
     */
    agentGenerativeSettingsPath(project: string, location: string, agent: string): string;
    /**
     * Parse the project from AgentGenerativeSettings resource.
     *
     * @param {string} agentGenerativeSettingsName
     *   A fully-qualified path representing AgentGenerativeSettings resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
    /**
     * Parse the location from AgentGenerativeSettings resource.
     *
     * @param {string} agentGenerativeSettingsName
     *   A fully-qualified path representing AgentGenerativeSettings resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
    /**
     * Parse the agent from AgentGenerativeSettings resource.
     *
     * @param {string} agentGenerativeSettingsName
     *   A fully-qualified path representing AgentGenerativeSettings resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
    /**
     * Return a fully-qualified agentValidationResult resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @returns {string} Resource name string.
     */
    agentValidationResultPath(project: string, location: string, agent: string): string;
    /**
     * Parse the project from AgentValidationResult resource.
     *
     * @param {string} agentValidationResultName
     *   A fully-qualified path representing AgentValidationResult resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;
    /**
     * Parse the location from AgentValidationResult resource.
     *
     * @param {string} agentValidationResultName
     *   A fully-qualified path representing AgentValidationResult resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;
    /**
     * Parse the agent from AgentValidationResult resource.
     *
     * @param {string} agentValidationResultName
     *   A fully-qualified path representing AgentValidationResult resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;
    /**
     * Return a fully-qualified changelog resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} agent
     * @param {string} changelog
     * @returns {string} Resource name string.
     */
    changelogPath(project: string, location: string, agent: string, changelog: string): string;
    /**
     * Parse the project from Changelog resource.
     *
     * @param {string} changelogName
     *   A fully-qualified path representing Changelog resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromChangelogName(changelogName: string): string | number;
    /**
     * Parse the location from Changelog resource.
     *
     * @param {string} changelogName
     *   A fully-qualified path representing Changelog resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromChangelogName(changelogName: string): string | number;
    /**
     * Parse the agent from Changelog resource.
     *
     * @param {string} changelogName
     *   A fully-qualified path representing Changelog resource.
     * @returns {string} A string representing the agent.
     */
    matchAgentFromChangelogName(changelogName: string): string | number;
    /**
     * Parse the changelog from Changelog resource.
     *
     * @param {string} changelogName
     *   A fully-qualified path representing Changelog resource.
     * @returns {string} A string representing the changelog.
     */
    matchChangelogFromChangelogName(changelogName: