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

Cx client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, 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.Environment|Environments}.
 * @class
 * @memberof v3
 */
export declare class EnvironmentsClient {
    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;
    environmentsStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of EnvironmentsClient.
     *
     * @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 EnvironmentsClient({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;
    /**
     * Retrieves the specified
     * {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the
     *   {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}. Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
     * @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.Environment|Environment}.
     *   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/environments.get_environment.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_GetEnvironment_async
     */
    getEnvironment(request?: protos.google.cloud.dialogflow.cx.v3.IGetEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IEnvironment,
        protos.google.cloud.dialogflow.cx.v3.IGetEnvironmentRequest | undefined,
        {} | undefined
    ]>;
    getEnvironment(request: protos.google.cloud.dialogflow.cx.v3.IGetEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IEnvironment, protos.google.cloud.dialogflow.cx.v3.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
    getEnvironment(request: protos.google.cloud.dialogflow.cx.v3.IGetEnvironmentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IEnvironment, protos.google.cloud.dialogflow.cx.v3.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes the specified
     * {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the
     *   {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment} to delete. Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
     * @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/environments.delete_environment.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_DeleteEnvironment_async
     */
    deleteEnvironment(request?: protos.google.cloud.dialogflow.cx.v3.IDeleteEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.cx.v3.IDeleteEnvironmentRequest | undefined,
        {} | undefined
    ]>;
    deleteEnvironment(request: protos.google.cloud.dialogflow.cx.v3.IDeleteEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>): void;
    deleteEnvironment(request: protos.google.cloud.dialogflow.cx.v3.IDeleteEnvironmentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates an {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment} in the
     * specified {@link protos.google.cloud.dialogflow.cx.v3.Agent|Agent}.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`: An empty [Struct
     *   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
     * - `response`: {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The {@link protos.google.cloud.dialogflow.cx.v3.Agent|Agent} to create an
     *   {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment} for. Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {google.cloud.dialogflow.cx.v3.Environment} request.environment
     *   Required. The environment 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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/environments.create_environment.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_CreateEnvironment_async
     */
    createEnvironment(request?: protos.google.cloud.dialogflow.cx.v3.ICreateEnvironmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IEnvironment, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createEnvironment(request: protos.google.cloud.dialogflow.cx.v3.ICreateEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createEnvironment(request: protos.google.cloud.dialogflow.cx.v3.ICreateEnvironmentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `createEnvironment()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/environments.create_environment.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_CreateEnvironment_async
     */
    checkCreateEnvironmentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.Environment, protos.google.protobuf.Struct>>;
    /**
     * Updates the specified
     * {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`: An empty [Struct
     *   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
     * - `response`: {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.dialogflow.cx.v3.Environment} request.environment
     *   Required. The environment to update.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Required. The mask to control which fields get 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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/environments.update_environment.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_UpdateEnvironment_async
     */
    updateEnvironment(request?: protos.google.cloud.dialogflow.cx.v3.IUpdateEnvironmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IEnvironment, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateEnvironment(request: protos.google.cloud.dialogflow.cx.v3.IUpdateEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateEnvironment(request: protos.google.cloud.dialogflow.cx.v3.IUpdateEnvironmentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `updateEnvironment()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/environments.update_environment.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_UpdateEnvironment_async
     */
    checkUpdateEnvironmentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.Environment, protos.google.protobuf.Struct>>;
    /**
     * Kicks off a continuous test under the specified
     * {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`:
     * {@link protos.google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata|RunContinuousTestMetadata}
     * - `response`:
     * {@link protos.google.cloud.dialogflow.cx.v3.RunContinuousTestResponse|RunContinuousTestResponse}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.environment
     *   Required. Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
     * @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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/environments.run_continuous_test.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_RunContinuousTest_async
     */
    runContinuousTest(request?: protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    runContinuousTest(request: protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    runContinuousTest(request: protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3.IRunContinuousTestMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `runContinuousTest()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/environments.run_continuous_test.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_RunContinuousTest_async
     */
    checkRunContinuousTestProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.RunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata>>;
    /**
     * Deploys a flow to the specified
     * {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`:
     * {@link protos.google.cloud.dialogflow.cx.v3.DeployFlowMetadata|DeployFlowMetadata}
     * - `response`:
     * {@link protos.google.cloud.dialogflow.cx.v3.DeployFlowResponse|DeployFlowResponse}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.environment
     *   Required. The environment to deploy the flow to.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
     * @param {string} request.flowVersion
     *   Required. The flow version to deploy.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/environments.deploy_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_DeployFlow_async
     */
    deployFlow(request?: protos.google.cloud.dialogflow.cx.v3.IDeployFlowRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3.IDeployFlowMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deployFlow(request: protos.google.cloud.dialogflow.cx.v3.IDeployFlowRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3.IDeployFlowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deployFlow(request: protos.google.cloud.dialogflow.cx.v3.IDeployFlowRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3.IDeployFlowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deployFlow()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3/environments.deploy_flow.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_DeployFlow_async
     */
    checkDeployFlowProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.DeployFlowResponse, protos.google.cloud.dialogflow.cx.v3.DeployFlowMetadata>>;
    /**
    * Returns the list of all environments in the specified
    * {@link protos.google.cloud.dialogflow.cx.v3.Agent|Agent}.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The {@link protos.google.cloud.dialogflow.cx.v3.Agent|Agent} to list all
    *   environments for. Format:
    *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
    * @param {number} request.pageSize
    *   The maximum number of items to return in a single page. By default 20 and
    *   at most 100.
    * @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.Environment|Environment}.
    *   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 `listEnvironmentsAsync()`
    *   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.
    */
    listEnvironments(request?: protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IEnvironment[],
        protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsResponse
    ]>;
    listEnvironments(request: protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest, protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IEnvironment>): void;
    listEnvironments(request: protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest, protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IEnvironment>): void;
    /**
     * Equivalent to `listEnvironments`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The {@link protos.google.cloud.dialogflow.cx.v3.Agent|Agent} to list all
     *   environments for. Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {number} request.pageSize
     *   The maximum number of items to return in a single page. By default 20 and
     *   at most 100.
     * @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.Environment|Environment} 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 `listEnvironmentsAsync()`
     *   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.
     */
    listEnvironmentsStream(request?: protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listEnvironments`, 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 {@link protos.google.cloud.dialogflow.cx.v3.Agent|Agent} to list all
     *   environments for. Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
     * @param {number} request.pageSize
     *   The maximum number of items to return in a single page. By default 20 and
     *   at most 100.
     * @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.Environment|Environment}. 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/environments.list_environments.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_ListEnvironments_async
     */
    listEnvironmentsAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListEnvironmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IEnvironment>;
    /**
    * Looks up the history of the specified
    * {@link protos.google.cloud.dialogflow.cx.v3.Environment|Environment}.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name
    *   Required. Resource name of the environment to look up the history for.
    *   Format:
    *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
    * @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.Environment|Environment}.
    *   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 `lookupEnvironmentHistoryAsync()`
    *   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.
    */
    lookupEnvironmentHistory(request?: protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IEnvironment[],
        protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest | null,
        protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryResponse
    ]>;
    lookupEnvironmentHistory(request: protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest, protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IEnvironment>): void;
    lookupEnvironmentHistory(request: protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest, protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IEnvironment>): void;
    /**
     * Equivalent to `lookupEnvironmentHistory`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Resource name of the environment to look up the history for.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
     * @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.Environment|Environment} 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 `lookupEnvironmentHistoryAsync()`
     *   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.
     */
    lookupEnvironmentHistoryStream(request?: protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `lookupEnvironmentHistory`, 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.name
     *   Required. Resource name of the environment to look up the history for.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
     * @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.Environment|Environment}. 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/environments.lookup_environment_history.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_LookupEnvironmentHistory_async
     */
    lookupEnvironmentHistoryAsync(request?: protos.google.cloud.dialogflow.cx.v3.ILookupEnvironmentHistoryRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IEnvironment>;
    /**
    * Fetches a list of continuous test results for a given environment.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The environment to list results for.
    *   Format:
    *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
    * @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.ContinuousTestResult|ContinuousTestResult}.
    *   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 `listContinuousTestResultsAsync()`
    *   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.
    */
    listContinuousTestResults(request?: protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.IContinuousTestResult[],
        protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsResponse
    ]>;
    listContinuousTestResults(request: protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest, protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IContinuousTestResult>): void;
    listContinuousTestResults(request: protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest, protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IContinuousTestResult>): void;
    /**
     * Equivalent to `listContinuousTestResults`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The environment to list results for.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
     * @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.ContinuousTestResult|ContinuousTestResult} 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 `listContinuousTestResultsAsync()`
     *   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.
     */
    listContinuousTestResultsStream(request?: protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listContinuousTestResults`, 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 environment to list results for.
     *   Format:
     *   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
     * @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.ContinuousTestResult|ContinuousTestResult}. 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/environments.list_continuous_test_results.js</caption>
     * region_tag:dialogflow_v3_generated_Environments_ListContinuousTestResults_async
     */
    listContinuousTestResultsAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListContinuousTestResultsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IContinuousTestResult>;
    /**
       * 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.long