Class v3.TestCasesClient (4.2.0)

Service for managing Test Cases and Test Case Results. v3

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of TestCasesClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof fallback` : 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 TestCasesClient({fallback: true}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

testCasesStub

testCasesStub?: Promise<{
        [name: string]: Function;
    }>;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

agentGenerativeSettingsPath(project, location, agent)

agentGenerativeSettingsPath(project: string, location: string, agent: string): string;

Return a fully-qualified agentGenerativeSettings resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

agentPath(project, location, agent)

agentPath(project: string, location: string, agent: string): string;

Return a fully-qualified agent resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

agentValidationResultPath(project, location, agent)

agentValidationResultPath(project: string, location: string, agent: string): string;

Return a fully-qualified agentValidationResult resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

batchDeleteTestCases(request, options)

batchDeleteTestCases(request?: protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest | undefined),
        {} | undefined
    ]>;

Batch deletes test cases.

Parameters
Name	Description
`request`	`IBatchDeleteTestCasesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent to delete test cases from.
   *  Format: `projects/

batchDeleteTestCases(request, options, callback)

batchDeleteTestCases(request: protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IBatchDeleteTestCasesRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

batchDeleteTestCases(request, callback)

batchDeleteTestCases(request: protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IBatchDeleteTestCasesRequest`
`callback`	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IBatchDeleteTestCasesRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

batchRunTestCases(request, options)

batchRunTestCases(request?: protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Kicks off a batch run of test cases.

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: BatchRunTestCasesMetadata - response: BatchRunTestCasesResponse

Parameters
Name	Description
`request`	`IBatchRunTestCasesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{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 documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Agent name. Format: `projects/

batchRunTestCases(request, options, callback)

batchRunTestCases(request: protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IBatchRunTestCasesRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

batchRunTestCases(request, callback)

batchRunTestCases(request: protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IBatchRunTestCasesRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IBatchRunTestCasesMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

calculateCoverage(request, options)

calculateCoverage(request?: protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageResponse,
        (protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest | undefined),
        {} | undefined
    ]>;

Calculates the test coverage for an agent.

Parameters
Name	Description
`request`	`ICalculateCoverageRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageResponse, (protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing CalculateCoverageResponse. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent to calculate coverage for.
   *  Format: `projects/

calculateCoverage(request, options, callback)

calculateCoverage(request: protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageResponse, protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICalculateCoverageRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageResponse, protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

calculateCoverage(request, callback)

calculateCoverage(request: protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageResponse, protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICalculateCoverageRequest`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageResponse, protos.google.cloud.dialogflow.cx.v3.ICalculateCoverageRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

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 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 value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`request`	`CancelOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} \| undefined \| null>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

changelogPath(project, location, agent, changelog)

changelogPath(project: string, location: string, agent: string, changelog: string): string;

Return a fully-qualified changelog resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`changelog`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

checkBatchRunTestCasesProgress(name)

checkBatchRunTestCasesProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata>>;

Check the status of the long running operation returned by batchRunTestCases().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Agent name. Format: `projects/

checkExportTestCasesProgress(name)

checkExportTestCasesProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.ExportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata>>;

Check the status of the long running operation returned by exportTestCases().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.ExportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent where to export test cases from.
   *  Format: `projects/

checkImportTestCasesProgress(name)

checkImportTestCasesProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.ImportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata>>;

Check the status of the long running operation returned by importTestCases().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.ImportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent to import test cases to.
   *  Format: `projects/

checkRunTestCaseProgress(name)

checkRunTestCaseProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.RunTestCaseResponse, protos.google.cloud.dialogflow.cx.v3.RunTestCaseMetadata>>;

Check the status of the long running operation returned by runTestCase().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.dialogflow.cx.v3.RunTestCaseResponse, protos.google.cloud.dialogflow.cx.v3.RunTestCaseMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format of test case name to run: `projects/

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
`Promise<void>`	{Promise} A promise that resolves when the client is closed.

continuousTestResultPath(project, location, agent, environment, continuousTestResult)

continuousTestResultPath(project: string, location: string, agent: string, environment: string, continuousTestResult: string): string;

Return a fully-qualified continuousTestResult resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`environment`	`string`
`continuousTestResult`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

createTestCase(request, options)

createTestCase(request?: protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITestCase,
        protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest | undefined,
        {} | undefined
    ]>;

Creates a test case for the given agent.

Parameters
Name	Description
`request`	`ICreateTestCaseRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestCase. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent to create the test case for.
   *  Format: `projects/

createTestCase(request, options, callback)

createTestCase(request: protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateTestCaseRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createTestCase(request, callback)

createTestCase(request: protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateTestCaseRequest`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.ICreateTestCaseRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: 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>;

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.

Parameters
Name	Description
`request`	`DeleteOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deploymentPath(project, location, agent, environment, deployment)

deploymentPath(project: string, location: string, agent: string, environment: string, deployment: string): string;

Return a fully-qualified deployment resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`environment`	`string`
`deployment`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

entityTypePath(project, location, agent, entityType)

entityTypePath(project: string, location: string, agent: string, entityType: string): string;

Return a fully-qualified entityType resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

environmentPath(project, location, agent, environment)

environmentPath(project: string, location: string, agent: string, environment: string): string;

Return a fully-qualified environment resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`environment`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

experimentPath(project, location, agent, environment, experiment)

experimentPath(project: string, location: string, agent: string, environment: string, experiment: string): string;

Return a fully-qualified experiment resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`environment`	`string`
`experiment`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

exportTestCases(request, options)

exportTestCases(request?: protos.google.cloud.dialogflow.cx.v3.IExportTestCasesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IExportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IExportTestCasesMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases.

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: ExportTestCasesMetadata - response: ExportTestCasesResponse

Parameters
Name	Description
`request`	`IExportTestCasesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.dialogflow.cx.v3.IExportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IExportTestCasesMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{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 documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent where to export test cases from.
   *  Format: `projects/

exportTestCases(request, options, callback)

exportTestCases(request: protos.google.cloud.dialogflow.cx.v3.IExportTestCasesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IExportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IExportTestCasesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IExportTestCasesRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IExportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IExportTestCasesMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

exportTestCases(request, callback)

exportTestCases(request: protos.google.cloud.dialogflow.cx.v3.IExportTestCasesRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IExportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IExportTestCasesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IExportTestCasesRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IExportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IExportTestCasesMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

flowPath(project, location, agent, flow)

flowPath(project: string, location: string, agent: string, flow: string): string;

Return a fully-qualified flow resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`flow`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

flowValidationResultPath(project, location, agent, flow)

flowValidationResultPath(project: string, location: string, agent: string, flow: string): string;

Return a fully-qualified flowValidationResult resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`flow`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

getLocation(request, options, callback)

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>;

Gets information about a location.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IGetLocationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
`callback`	`Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`Promise<google.cloud.location.ILocation>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


const [response] = await client.getLocation(request);

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: 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]>;

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.

Parameters
Name	Description
`request`	`GetOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<[protos.google.longrunning.Operation]>`

Example


const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
`Promise<string>`

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
`callback`	`Callback<string, undefined, undefined>`

Returns
Type	Description
`void`

getTestCase(request, options)

getTestCase(request?: protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITestCase,
        protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest | undefined,
        {} | undefined
    ]>;

Gets a test case.

Parameters
Name	Description
`request`	`IGetTestCaseRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestCase. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the testcase.
   *  Format: `projects/

getTestCase(request, options, callback)

getTestCase(request: protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetTestCaseRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getTestCase(request, callback)

getTestCase(request: protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetTestCaseRequest`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getTestCaseResult(request, options)

getTestCaseResult(request?: protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITestCaseResult,
        (protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest | undefined),
        {} | undefined
    ]>;

Gets a test case result.

Parameters
Name	Description
`request`	`IGetTestCaseResultRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.dialogflow.cx.v3.ITestCaseResult, (protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestCaseResult. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the testcase.
   *  Format: `projects/

getTestCaseResult(request, options, callback)

getTestCaseResult(request: protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITestCaseResult, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetTestCaseResultRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ITestCaseResult, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getTestCaseResult(request, callback)

getTestCaseResult(request: protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITestCaseResult, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetTestCaseResultRequest`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ITestCaseResult, protos.google.cloud.dialogflow.cx.v3.IGetTestCaseResultRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

importTestCases(request, options)

importTestCases(request?: protos.google.cloud.dialogflow.cx.v3.IImportTestCasesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IImportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IImportTestCasesMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected.

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: ImportTestCasesMetadata - response: ImportTestCasesResponse

Parameters
Name	Description
`request`	`IImportTestCasesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.dialogflow.cx.v3.IImportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IImportTestCasesMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{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 documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent to import test cases to.
   *  Format: `projects/

importTestCases(request, options, callback)

importTestCases(request: protos.google.cloud.dialogflow.cx.v3.IImportTestCasesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IImportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IImportTestCasesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IImportTestCasesRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IImportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IImportTestCasesMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

importTestCases(request, callback)

importTestCases(request: protos.google.cloud.dialogflow.cx.v3.IImportTestCasesRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IImportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IImportTestCasesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IImportTestCasesRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IImportTestCasesResponse, protos.google.cloud.dialogflow.cx.v3.IImportTestCasesMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
Type	Description
`Promise<{ [name: string]: Function; }>`	{Promise} A promise that resolves to an authenticated service stub.

intentPath(project, location, agent, intent)

intentPath(project: string, location: string, agent: string, intent: string): string;

Return a fully-qualified intent resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`intent`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<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.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<google.cloud.location.ILocation>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 documentation for more details and examples.

Example


const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

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.

Parameters
Name	Description
`request`	`ListOperationsRequest` The request object that will be sent.
`options`	`CallOptions` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
`AsyncIterable<protos.google.longrunning.ListOperationsResponse>`	{Object} An iterable Object that conforms to iteration protocols.

Example


const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listTestCaseResults(request, options)

listTestCaseResults(request?: protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITestCaseResult[],
        protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsResponse
    ]>;

Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.

Parameters
Name	Description
`request`	`IListTestCaseResultsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITestCaseResult[],
        protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of TestCaseResult. 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 listTestCaseResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTestCaseResults(request, options, callback)

listTestCaseResults(request: protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.ITestCaseResult>): void;

Parameters
Name	Description
`request`	`IListTestCaseResultsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsResponse \| null \| undefined, protos.google.cloud.dialogflow.cx.v3.ITestCaseResult>`

Returns
Type	Description
`void`

listTestCaseResults(request, callback)

listTestCaseResults(request: protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.ITestCaseResult>): void;

Parameters
Name	Description
`request`	`IListTestCaseResultsRequest`
`callback`	`PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsResponse \| null \| undefined, protos.google.cloud.dialogflow.cx.v3.ITestCaseResult>`

Returns
Type	Description
`void`

listTestCaseResultsAsync(request, options)

listTestCaseResultsAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.ITestCaseResult>;

Equivalent to listTestCaseResults, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`IListTestCaseResultsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<protos.google.cloud.dialogflow.cx.v3.ITestCaseResult>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing TestCaseResult. 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 documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The test case to list results for.
   *  Format: `projects/

listTestCaseResultsStream(request, options)

listTestCaseResultsStream(request?: protos.google.cloud.dialogflow.cx.v3.IListTestCaseResultsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`IListTestCaseResultsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing TestCaseResult 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 listTestCaseResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTestCases(request, options)

listTestCases(request?: protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITestCase[],
        protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListTestCasesResponse
    ]>;

Fetches a list of test cases for a given agent.

Parameters
Name	Description
`request`	`IListTestCasesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITestCase[],
        protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest | null,
        protos.google.cloud.dialogflow.cx.v3.IListTestCasesResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of TestCase. 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 listTestCasesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTestCases(request, options, callback)

listTestCases(request: protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, protos.google.cloud.dialogflow.cx.v3.IListTestCasesResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.ITestCase>): void;

Parameters
Name	Description
`request`	`IListTestCasesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, protos.google.cloud.dialogflow.cx.v3.IListTestCasesResponse \| null \| undefined, protos.google.cloud.dialogflow.cx.v3.ITestCase>`

Returns
Type	Description
`void`

listTestCases(request, callback)

listTestCases(request: protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, protos.google.cloud.dialogflow.cx.v3.IListTestCasesResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.ITestCase>): void;

Parameters
Name	Description
`request`	`IListTestCasesRequest`
`callback`	`PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, protos.google.cloud.dialogflow.cx.v3.IListTestCasesResponse \| null \| undefined, protos.google.cloud.dialogflow.cx.v3.ITestCase>`

Returns
Type	Description
`void`

listTestCasesAsync(request, options)

listTestCasesAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.ITestCase>;

Equivalent to listTestCases, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`IListTestCasesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<protos.google.cloud.dialogflow.cx.v3.ITestCase>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing TestCase. 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 documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent to list all pages for.
   *  Format: `projects/

listTestCasesStream(request, options)

listTestCasesStream(request?: protos.google.cloud.dialogflow.cx.v3.IListTestCasesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`IListTestCasesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing TestCase 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 listTestCasesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName)

matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;

Parse the agent from AgentGenerativeSettings resource.

Parameter
Name	Description
`agentGenerativeSettingsName`	`string` A fully-qualified path representing AgentGenerativeSettings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromAgentName(agentName)

matchAgentFromAgentName(agentName: string): string | number;

Parse the agent from Agent resource.

Parameter
Name	Description
`agentName`	`string` A fully-qualified path representing Agent resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromAgentValidationResultName(agentValidationResultName)

matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the agent from AgentValidationResult resource.

Parameter
Name	Description
`agentValidationResultName`	`string` A fully-qualified path representing AgentValidationResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromChangelogName(changelogName)

matchAgentFromChangelogName(changelogName: string): string | number;

Parse the agent from Changelog resource.

Parameter
Name	Description
`changelogName`	`string` A fully-qualified path representing Changelog resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromContinuousTestResultName(continuousTestResultName)

matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the agent from ContinuousTestResult resource.

Parameter
Name	Description
`continuousTestResultName`	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromDeploymentName(deploymentName)

matchAgentFromDeploymentName(deploymentName: string): string | number;

Parse the agent from Deployment resource.

Parameter
Name	Description
`deploymentName`	`string` A fully-qualified path representing Deployment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromEntityTypeName(entityTypeName)

matchAgentFromEntityTypeName(entityTypeName: string): string | number;

Parse the agent from EntityType resource.

Parameter
Name	Description
`entityTypeName`	`string` A fully-qualified path representing EntityType resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromEnvironmentName(environmentName)

matchAgentFromEnvironmentName(environmentName: string): string | number;

Parse the agent from Environment resource.

Parameter
Name	Description
`environmentName`	`string` A fully-qualified path representing Environment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromExperimentName(experimentName)

matchAgentFromExperimentName(experimentName: string): string | number;

Parse the agent from Experiment resource.

Parameter
Name	Description
`experimentName`	`string` A fully-qualified path representing Experiment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromFlowName(flowName)

matchAgentFromFlowName(flowName: string): string | number;

Parse the agent from Flow resource.

Parameter
Name	Description
`flowName`	`string` A fully-qualified path representing Flow resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromFlowValidationResultName(flowValidationResultName)

matchAgentFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the agent from FlowValidationResult resource.

Parameter
Name	Description
`flowValidationResultName`	`string` A fully-qualified path representing FlowValidationResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromIntentName(intentName)

matchAgentFromIntentName(intentName: string): string | number;

Parse the agent from Intent resource.

Parameter
Name	Description
`intentName`	`string` A fully-qualified path representing Intent resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromPageName(pageName)

matchAgentFromPageName(pageName: string): string | number;

Parse the agent from Page resource.

Parameter
Name	Description
`pageName`	`string` A fully-qualified path representing Page resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentEnvironmentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)

matchAgentFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;

Parse the agent from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentFlowTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_flow_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)

matchAgentFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName: string): string | number;

Parse the agent from ProjectLocationAgentTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromTestCaseName(testCaseName)

matchAgentFromTestCaseName(testCaseName: string): string | number;

Parse the agent from TestCase resource.

Parameter
Name	Description
`testCaseName`	`string` A fully-qualified path representing TestCase resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromTestCaseResultName(testCaseResultName)

matchAgentFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the agent from TestCaseResult resource.

Parameter
Name	Description
`testCaseResultName`	`string` A fully-qualified path representing TestCaseResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromVersionName(versionName)

matchAgentFromVersionName(versionName: string): string | number;

Parse the agent from Version resource.

Parameter
Name	Description
`versionName`	`string` A fully-qualified path representing Version resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchAgentFromWebhookName(webhookName)

matchAgentFromWebhookName(webhookName: string): string | number;

Parse the agent from Webhook resource.

Parameter
Name	Description
`webhookName`	`string` A fully-qualified path representing Webhook resource.

Returns
Type	Description
`string \| number`	{string} A string representing the agent.

matchChangelogFromChangelogName(changelogName)

matchChangelogFromChangelogName(changelogName: string): string | number;

Parse the changelog from Changelog resource.

Parameter
Name	Description
`changelogName`	`string` A fully-qualified path representing Changelog resource.

Returns
Type	Description
`string \| number`	{string} A string representing the changelog.

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName)

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the continuous_test_result from ContinuousTestResult resource.

Parameter
Name	Description
`continuousTestResultName`	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the continuous_test_result.

matchDeploymentFromDeploymentName(deploymentName)

matchDeploymentFromDeploymentName(deploymentName: string): string | number;

Parse the deployment from Deployment resource.

Parameter
Name	Description
`deploymentName`	`string` A fully-qualified path representing Deployment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the deployment.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter
Name	Description
`entityTypeName`	`string` A fully-qualified path representing EntityType resource.

Returns
Type	Description
`string \| number`	{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentEnvironmentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the entity_type.

matchEnvironmentFromContinuousTestResultName(continuousTestResultName)

matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the environment from ContinuousTestResult resource.

Parameter
Name	Description
`continuousTestResultName`	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the environment.

matchEnvironmentFromDeploymentName(deploymentName)

matchEnvironmentFromDeploymentName(deploymentName: string): string | number;

Parse the environment from Deployment resource.

Parameter
Name	Description
`deploymentName`	`string` A fully-qualified path representing Deployment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the environment.

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

Parameter
Name	Description
`environmentName`	`string` A fully-qualified path representing Environment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the environment.

matchEnvironmentFromExperimentName(experimentName)

matchEnvironmentFromExperimentName(experimentName: string): string | number;

Parse the environment from Experiment resource.

Parameter
Name	Description
`experimentName`	`string` A fully-qualified path representing Experiment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentEnvironmentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the environment.

matchExperimentFromExperimentName(experimentName)

matchExperimentFromExperimentName(experimentName: string): string | number;

Parse the experiment from Experiment resource.

Parameter
Name	Description
`experimentName`	`string` A fully-qualified path representing Experiment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the experiment.

matchFlowFromFlowName(flowName)

matchFlowFromFlowName(flowName: string): string | number;

Parse the flow from Flow resource.

Parameter
Name	Description
`flowName`	`string` A fully-qualified path representing Flow resource.

Returns
Type	Description
`string \| number`	{string} A string representing the flow.

matchFlowFromFlowValidationResultName(flowValidationResultName)

matchFlowFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the flow from FlowValidationResult resource.

Parameter
Name	Description
`flowValidationResultName`	`string` A fully-qualified path representing FlowValidationResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the flow.

matchFlowFromPageName(pageName)

matchFlowFromPageName(pageName: string): string | number;

Parse the flow from Page resource.

Parameter
Name	Description
`pageName`	`string` A fully-qualified path representing Page resource.

Returns
Type	Description
`string \| number`	{string} A string representing the flow.

matchFlowFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)

matchFlowFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;

Parse the flow from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentFlowTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_flow_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the flow.

matchFlowFromVersionName(versionName)

matchFlowFromVersionName(versionName: string): string | number;

Parse the flow from Version resource.

Parameter
Name	Description
`versionName`	`string` A fully-qualified path representing Version resource.

Returns
Type	Description
`string \| number`	{string} A string representing the flow.

matchIntentFromIntentName(intentName)

matchIntentFromIntentName(intentName: string): string | number;

Parse the intent from Intent resource.

Parameter
Name	Description
`intentName`	`string` A fully-qualified path representing Intent resource.

Returns
Type	Description
`string \| number`	{string} A string representing the intent.

matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName)

matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;

Parse the location from AgentGenerativeSettings resource.

Parameter
Name	Description
`agentGenerativeSettingsName`	`string` A fully-qualified path representing AgentGenerativeSettings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromAgentName(agentName)

matchLocationFromAgentName(agentName: string): string | number;

Parse the location from Agent resource.

Parameter
Name	Description
`agentName`	`string` A fully-qualified path representing Agent resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromAgentValidationResultName(agentValidationResultName)

matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the location from AgentValidationResult resource.

Parameter
Name	Description
`agentValidationResultName`	`string` A fully-qualified path representing AgentValidationResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromChangelogName(changelogName)

matchLocationFromChangelogName(changelogName: string): string | number;

Parse the location from Changelog resource.

Parameter
Name	Description
`changelogName`	`string` A fully-qualified path representing Changelog resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromContinuousTestResultName(continuousTestResultName)

matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the location from ContinuousTestResult resource.

Parameter
Name	Description
`continuousTestResultName`	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromDeploymentName(deploymentName)

matchLocationFromDeploymentName(deploymentName: string): string | number;

Parse the location from Deployment resource.

Parameter
Name	Description
`deploymentName`	`string` A fully-qualified path representing Deployment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter
Name	Description
`entityTypeName`	`string` A fully-qualified path representing EntityType resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

Parse the location from Environment resource.

Parameter
Name	Description
`environmentName`	`string` A fully-qualified path representing Environment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromExperimentName(experimentName)

matchLocationFromExperimentName(experimentName: string): string | number;

Parse the location from Experiment resource.

Parameter
Name	Description
`experimentName`	`string` A fully-qualified path representing Experiment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromFlowName(flowName)

matchLocationFromFlowName(flowName: string): string | number;

Parse the location from Flow resource.

Parameter
Name	Description
`flowName`	`string` A fully-qualified path representing Flow resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromFlowValidationResultName(flowValidationResultName)

matchLocationFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the location from FlowValidationResult resource.

Parameter
Name	Description
`flowValidationResultName`	`string` A fully-qualified path representing FlowValidationResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromIntentName(intentName)

matchLocationFromIntentName(intentName: string): string | number;

Parse the location from Intent resource.

Parameter
Name	Description
`intentName`	`string` A fully-qualified path representing Intent resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromPageName(pageName)

matchLocationFromPageName(pageName: string): string | number;

Parse the location from Page resource.

Parameter
Name	Description
`pageName`	`string` A fully-qualified path representing Page resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentEnvironmentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)

matchLocationFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;

Parse the location from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentFlowTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_flow_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)

matchLocationFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName: string): string | number;

Parse the location from ProjectLocationAgentTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromSecuritySettingsName(securitySettingsName)

matchLocationFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the location from SecuritySettings resource.

Parameter
Name	Description
`securitySettingsName`	`string` A fully-qualified path representing SecuritySettings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromTestCaseName(testCaseName)

matchLocationFromTestCaseName(testCaseName: string): string | number;

Parse the location from TestCase resource.

Parameter
Name	Description
`testCaseName`	`string` A fully-qualified path representing TestCase resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromTestCaseResultName(testCaseResultName)

matchLocationFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the location from TestCaseResult resource.

Parameter
Name	Description
`testCaseResultName`	`string` A fully-qualified path representing TestCaseResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromVersionName(versionName)

matchLocationFromVersionName(versionName: string): string | number;

Parse the location from Version resource.

Parameter
Name	Description
`versionName`	`string` A fully-qualified path representing Version resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromWebhookName(webhookName)

matchLocationFromWebhookName(webhookName: string): string | number;

Parse the location from Webhook resource.

Parameter
Name	Description
`webhookName`	`string` A fully-qualified path representing Webhook resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchPageFromPageName(pageName)

matchPageFromPageName(pageName: string): string | number;

Parse the page from Page resource.

Parameter
Name	Description
`pageName`	`string` A fully-qualified path representing Page resource.

Returns
Type	Description
`string \| number`	{string} A string representing the page.

matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName)

matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;

Parse the project from AgentGenerativeSettings resource.

Parameter
Name	Description
`agentGenerativeSettingsName`	`string` A fully-qualified path representing AgentGenerativeSettings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromAgentName(agentName)

matchProjectFromAgentName(agentName: string): string | number;

Parse the project from Agent resource.

Parameter
Name	Description
`agentName`	`string` A fully-qualified path representing Agent resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromAgentValidationResultName(agentValidationResultName)

matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the project from AgentValidationResult resource.

Parameter
Name	Description
`agentValidationResultName`	`string` A fully-qualified path representing AgentValidationResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromChangelogName(changelogName)

matchProjectFromChangelogName(changelogName: string): string | number;

Parse the project from Changelog resource.

Parameter
Name	Description
`changelogName`	`string` A fully-qualified path representing Changelog resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromContinuousTestResultName(continuousTestResultName)

matchProjectFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the project from ContinuousTestResult resource.

Parameter
Name	Description
`continuousTestResultName`	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromDeploymentName(deploymentName)

matchProjectFromDeploymentName(deploymentName: string): string | number;

Parse the project from Deployment resource.

Parameter
Name	Description
`deploymentName`	`string` A fully-qualified path representing Deployment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter
Name	Description
`entityTypeName`	`string` A fully-qualified path representing EntityType resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

Parse the project from Environment resource.

Parameter
Name	Description
`environmentName`	`string` A fully-qualified path representing Environment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromExperimentName(experimentName)

matchProjectFromExperimentName(experimentName: string): string | number;

Parse the project from Experiment resource.

Parameter
Name	Description
`experimentName`	`string` A fully-qualified path representing Experiment resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromFlowName(flowName)

matchProjectFromFlowName(flowName: string): string | number;

Parse the project from Flow resource.

Parameter
Name	Description
`flowName`	`string` A fully-qualified path representing Flow resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromFlowValidationResultName(flowValidationResultName)

matchProjectFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the project from FlowValidationResult resource.

Parameter
Name	Description
`flowValidationResultName`	`string` A fully-qualified path representing FlowValidationResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromIntentName(intentName)

matchProjectFromIntentName(intentName: string): string | number;

Parse the project from Intent resource.

Parameter
Name	Description
`intentName`	`string` A fully-qualified path representing Intent resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromPageName(pageName)

matchProjectFromPageName(pageName: string): string | number;

Parse the project from Page resource.

Parameter
Name	Description
`pageName`	`string` A fully-qualified path representing Page resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentEnvironmentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)

matchProjectFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;

Parse the project from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentFlowTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_flow_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)

matchProjectFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName: string): string | number;

Parse the project from ProjectLocationAgentTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
`projectName`	`string` A fully-qualified path representing Project resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromSecuritySettingsName(securitySettingsName)

matchProjectFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the project from SecuritySettings resource.

Parameter
Name	Description
`securitySettingsName`	`string` A fully-qualified path representing SecuritySettings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromTestCaseName(testCaseName)

matchProjectFromTestCaseName(testCaseName: string): string | number;

Parse the project from TestCase resource.

Parameter
Name	Description
`testCaseName`	`string` A fully-qualified path representing TestCase resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromTestCaseResultName(testCaseResultName)

matchProjectFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the project from TestCaseResult resource.

Parameter
Name	Description
`testCaseResultName`	`string` A fully-qualified path representing TestCaseResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromVersionName(versionName)

matchProjectFromVersionName(versionName: string): string | number;

Parse the project from Version resource.

Parameter
Name	Description
`versionName`	`string` A fully-qualified path representing Version resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromWebhookName(webhookName)

matchProjectFromWebhookName(webhookName: string): string | number;

Parse the project from Webhook resource.

Parameter
Name	Description
`webhookName`	`string` A fully-qualified path representing Webhook resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchResultFromTestCaseResultName(testCaseResultName)

matchResultFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the result from TestCaseResult resource.

Parameter
Name	Description
`testCaseResultName`	`string` A fully-qualified path representing TestCaseResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the result.

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName)

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the security_settings from SecuritySettings resource.

Parameter
Name	Description
`securitySettingsName`	`string` A fully-qualified path representing SecuritySettings resource.

Returns
Type	Description
`string \| number`	{string} A string representing the security_settings.

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentEnvironmentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameter
Name	Description
`projectLocationAgentSessionEntityTypeName`	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
Type	Description
`string \| number`	{string} A string representing the session.

matchTestCaseFromTestCaseName(testCaseName)

matchTestCaseFromTestCaseName(testCaseName: string): string | number;

Parse the test_case from TestCase resource.

Parameter
Name	Description
`testCaseName`	`string` A fully-qualified path representing TestCase resource.

Returns
Type	Description
`string \| number`	{string} A string representing the test_case.

matchTestCaseFromTestCaseResultName(testCaseResultName)

matchTestCaseFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the test_case from TestCaseResult resource.

Parameter
Name	Description
`testCaseResultName`	`string` A fully-qualified path representing TestCaseResult resource.

Returns
Type	Description
`string \| number`	{string} A string representing the test_case.

matchTransitionRouteGroupFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)

matchTransitionRouteGroupFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;

Parse the transition_route_group from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentFlowTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_flow_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the transition_route_group.

matchTransitionRouteGroupFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)

matchTransitionRouteGroupFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName: string): string | number;

Parse the transition_route_group from ProjectLocationAgentTransitionRouteGroup resource.

Parameter
Name	Description
`projectLocationAgentTransitionRouteGroupName`	`string` A fully-qualified path representing project_location_agent_transition_route_group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the transition_route_group.

matchVersionFromVersionName(versionName)

matchVersionFromVersionName(versionName: string): string | number;

Parse the version from Version resource.

Parameter
Name	Description
`versionName`	`string` A fully-qualified path representing Version resource.

Returns
Type	Description
`string \| number`	{string} A string representing the version.

matchWebhookFromWebhookName(webhookName)

matchWebhookFromWebhookName(webhookName: string): string | number;

Parse the webhook from Webhook resource.

Parameter
Name	Description
`webhookName`	`string` A fully-qualified path representing Webhook resource.

Returns
Type	Description
`string \| number`	{string} A string representing the webhook.

pagePath(project, location, agent, flow, page)

pagePath(project: string, location: string, agent: string, flow: string, page: string): string;

Return a fully-qualified page resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`flow`	`string`
`page`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationAgentEnvironmentSessionEntityTypePath(project, location, agent, environment, session, entityType)

projectLocationAgentEnvironmentSessionEntityTypePath(project: string, location: string, agent: string, environment: string, session: string, entityType: string): string;

Return a fully-qualified projectLocationAgentEnvironmentSessionEntityType resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`environment`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationAgentFlowTransitionRouteGroupPath(project, location, agent, flow, transitionRouteGroup)

projectLocationAgentFlowTransitionRouteGroupPath(project: string, location: string, agent: string, flow: string, transitionRouteGroup: string): string;

Return a fully-qualified projectLocationAgentFlowTransitionRouteGroup resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`flow`	`string`
`transitionRouteGroup`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationAgentSessionEntityTypePath(project, location, agent, session, entityType)

projectLocationAgentSessionEntityTypePath(project: string, location: string, agent: string, session: string, entityType: string): string;

Return a fully-qualified projectLocationAgentSessionEntityType resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationAgentTransitionRouteGroupPath(project, location, agent, transitionRouteGroup)

projectLocationAgentTransitionRouteGroupPath(project: string, location: string, agent: string, transitionRouteGroup: string): string;

Return a fully-qualified projectLocationAgentTransitionRouteGroup resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`transitionRouteGroup`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

runTestCase(request, options)

runTestCase(request?: protos.google.cloud.dialogflow.cx.v3.IRunTestCaseRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3.IRunTestCaseResponse, protos.google.cloud.dialogflow.cx.v3.IRunTestCaseMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Kicks off a test case run.

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: RunTestCaseMetadata - response: RunTestCaseResponse

Parameters
Name	Description
`request`	`IRunTestCaseRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.dialogflow.cx.v3.IRunTestCaseResponse, protos.google.cloud.dialogflow.cx.v3.IRunTestCaseMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{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 documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format of test case name to run: `projects/

runTestCase(request, options, callback)

runTestCase(request: protos.google.cloud.dialogflow.cx.v3.IRunTestCaseRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IRunTestCaseResponse, protos.google.cloud.dialogflow.cx.v3.IRunTestCaseMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IRunTestCaseRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IRunTestCaseResponse, protos.google.cloud.dialogflow.cx.v3.IRunTestCaseMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

runTestCase(request, callback)

runTestCase(request: protos.google.cloud.dialogflow.cx.v3.IRunTestCaseRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IRunTestCaseResponse, protos.google.cloud.dialogflow.cx.v3.IRunTestCaseMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IRunTestCaseRequest`
`callback`	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3.IRunTestCaseResponse, protos.google.cloud.dialogflow.cx.v3.IRunTestCaseMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

securitySettingsPath(project, location, securitySettings)

securitySettingsPath(project: string, location: string, securitySettings: string): string;

Return a fully-qualified securitySettings resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`securitySettings`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

testCasePath(project, location, agent, testCase)

testCasePath(project: string, location: string, agent: string, testCase: string): string;

Return a fully-qualified testCase resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`testCase`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

testCaseResultPath(project, location, agent, testCase, result)

testCaseResultPath(project: string, location: string, agent: string, testCase: string, result: string): string;

Return a fully-qualified testCaseResult resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`testCase`	`string`
`result`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

updateTestCase(request, options)

updateTestCase(request?: protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3.ITestCase,
        protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest | undefined,
        {} | undefined
    ]>;

Updates the specified test case.

Parameters
Name	Description
`request`	`IUpdateTestCaseRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestCase. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The test case to update.
   */
  // const testCase = {}
  /**
   *  Required. The mask to specify which fields should be updated. The
   *  `creationTime` google.cloud.dialogflow.cx.v3.TestCase.creation_time  and
   *  `lastTestResult` google.cloud.dialogflow.cx.v3.TestCase.last_test_result 
   *  cannot be updated.
   */
  // const updateMask = {}

  // Imports the Cx library
  const {TestCasesClient} = require('@google-cloud/dialogflow-cx').v3;

  // Instantiates a client
  const cxClient = new TestCasesClient();

  async function callUpdateTestCase() {
    // Construct request
    const request = {
      testCase,
      updateMask,
    };

    // Run request
    const response = await cxClient.updateTestCase(request);
    console.log(response);
  }

  callUpdateTestCase();

updateTestCase(request, options, callback)

updateTestCase(request: protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateTestCaseRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateTestCase(request, callback)

updateTestCase(request: protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateTestCaseRequest`
`callback`	`Callback<protos.google.cloud.dialogflow.cx.v3.ITestCase, protos.google.cloud.dialogflow.cx.v3.IUpdateTestCaseRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

versionPath(project, location, agent, flow, version)

versionPath(project: string, location: string, agent: string, flow: string, version: string): string;

Return a fully-qualified version resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`flow`	`string`
`version`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

webhookPath(project, location, agent, webhook)

webhookPath(project: string, location: string, agent: string, webhook: string): string;

Return a fully-qualified webhook resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`webhook`	`string`

Returns
Type	Description
`string`	{string} Resource name string.