Class v3beta1.EnvironmentsClient (3.1.2)

Stay organized with collections Save and categorize content based on your preferences.

Service for managing . v3beta1

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of EnvironmentsClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof gax.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 EnvironmentsClient({fallback: 'rest'}, 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;

environmentsStub

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

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.

warn

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

Methods

agentPath(project, location, agent)

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

Return a fully-qualified agent resource name string.

Parameters
NameDescription
project string
location string
agent string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
Returns
TypeDescription
string

{string} Resource name string.

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
NameDescription
request protos.google.longrunning.CancelOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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
TypeDescription
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
NameDescription
project string
location string
agent string
changelog string
Returns
TypeDescription
string

{string} Resource name string.

checkCreateEnvironmentProgress(name)

checkCreateEnvironmentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.Environment, protos.google.protobuf.Struct>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.Environment, protos.google.protobuf.Struct>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 google.cloud.dialogflow.cx.v3beta1.Agent  to create an Environment google.cloud.dialogflow.cx.v3beta1.Environment  for.
   *  Format: `projects/

checkDeployFlowProgress(name)

checkDeployFlowProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.DeployFlowResponse, protos.google.cloud.dialogflow.cx.v3beta1.DeployFlowMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.DeployFlowResponse, protos.google.cloud.dialogflow.cx.v3beta1.DeployFlowMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 environment to deploy the flow to.
   *  Format: `projects/

checkRunContinuousTestProgress(name)

checkRunContinuousTestProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.RunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3beta1.RunContinuousTestMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.RunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3beta1.RunContinuousTestMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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: `projects/

checkUpdateEnvironmentProgress(name)

checkUpdateEnvironmentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.Environment, protos.google.protobuf.Struct>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.Environment, protos.google.protobuf.Struct>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 environment to update.
   */
  // const environment = {}
  /**
   *  Required. The mask to control which fields get updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateEnvironment() {
    // Construct request
    const request = {
      environment,
      updateMask,
    };

    // Run request
    const [operation] = await cxClient.updateEnvironment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateEnvironment();

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
TypeDescription
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
NameDescription
project string
location string
agent string
environment string
continuousTestResult string
Returns
TypeDescription
string

{string} Resource name string.

createEnvironment(request, options)

createEnvironment(request?: protos.google.cloud.dialogflow.cx.v3beta1.ICreateEnvironmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an in the specified .

This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

  • metadata: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - response:
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ICreateEnvironmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 google.cloud.dialogflow.cx.v3beta1.Agent  to create an Environment google.cloud.dialogflow.cx.v3beta1.Environment  for.
   *  Format: `projects/

createEnvironment(request, options, callback)

createEnvironment(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreateEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ICreateEnvironmentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createEnvironment(request, callback)

createEnvironment(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreateEnvironmentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ICreateEnvironmentRequest
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteEnvironment(request, options)

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

Deletes the specified .

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest | 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 Environment google.cloud.dialogflow.cx.v3beta1.Environment  to delete.
   *  Format: `projects/

deleteEnvironment(request, options, callback)

deleteEnvironment(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteEnvironment(request, callback)

deleteEnvironment(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
NameDescription
request protos.google.longrunning.DeleteOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

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

deployFlow(request, options)

deployFlow(request?: protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deploys a flow to the specified .

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: - response:
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowMetadata>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 environment to deploy the flow to.
   *  Format: `projects/

deployFlow(request, options, callback)

deployFlow(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deployFlow(request, callback)

deployFlow(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowRequest
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowResponse, protos.google.cloud.dialogflow.cx.v3beta1.IDeployFlowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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
NameDescription
project string
location string
agent string
environment string
deployment string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
entityType string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
environment string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
environment string
experiment string
Returns
TypeDescription
string

{string} Resource name string.

flowPath(project, location, agent, flow)

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

Return a fully-qualified flow resource name string.

Parameters
NameDescription
project string
location string
agent string
flow string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
flow string
Returns
TypeDescription
string

{string} Resource name string.

getEnvironment(request, options)

getEnvironment(request?: protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment,
        (protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest | undefined),
        {} | undefined
    ]>;

Retrieves the specified .

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, (protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Environment]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 Environment google.cloud.dialogflow.cx.v3beta1.Environment.
   *  Format: `projects/

getEnvironment(request, options, callback)

getEnvironment(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getEnvironment(request, callback)

getEnvironment(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest
callback Callback<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.cloud.dialogflow.cx.v3beta1.IGetEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<LocationProtos.google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Location]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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
NameDescription
request protos.google.longrunning.GetOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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 [google.longrunning.Operation]. {Promise} - The promise which resolves to an array. The first element of the array is an object representing [google.longrunning.Operation]. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
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
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
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
NameDescription
project string
location string
agent string
intent string
Returns
TypeDescription
string

{string} Resource name string.

listContinuousTestResults(request, options)

listContinuousTestResults(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IContinuousTestResult[],
        protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest | null,
        protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsResponse
    ]>;

Fetches a list of continuous test results for a given environment.

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dialogflow.cx.v3beta1.IContinuousTestResult[], protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [ContinuousTestResult]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listContinuousTestResultsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listContinuousTestResults(request, options, callback)

listContinuousTestResults(request: protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IContinuousTestResult>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IContinuousTestResult>
Returns
TypeDescription
void

listContinuousTestResults(request, callback)

listContinuousTestResults(request: protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IContinuousTestResult>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest
callback PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IContinuousTestResult>
Returns
TypeDescription
void

listContinuousTestResultsAsync(request, options)

listContinuousTestResultsAsync(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IContinuousTestResult>;

Equivalent to listContinuousTestResults, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IContinuousTestResult>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ContinuousTestResult]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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 environment to list results for.
   *  Format: `projects/

listContinuousTestResultsStream(request, options)

listContinuousTestResultsStream(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListContinuousTestResultsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [ContinuousTestResult] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listContinuousTestResultsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEnvironments(request, options)

listEnvironments(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment[],
        protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest | null,
        protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsResponse
    ]>;

Returns the list of all environments in the specified .

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment[], protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Environment]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listEnvironmentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEnvironments(request, options, callback)

listEnvironments(request: protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>
Returns
TypeDescription
void

listEnvironments(request, callback)

listEnvironments(request: protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest
callback PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>
Returns
TypeDescription
void

listEnvironmentsAsync(request, options)

listEnvironmentsAsync(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>;

Equivalent to listEnvironments, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Environment]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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 google.cloud.dialogflow.cx.v3beta1.Agent  to list all environments for.
   *  Format: `projects/

listEnvironmentsStream(request, options)

listEnvironmentsStream(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListEnvironmentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Environment] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEnvironmentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<LocationProtos.google.cloud.location.ILocation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Location]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
request protos.google.longrunning.ListOperationsRequest

The request object that will be sent.

options gax.CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details.

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Example

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

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

lookupEnvironmentHistory(request, options)

lookupEnvironmentHistory(request?: protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment[],
        protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest | null,
        protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryResponse
    ]>;

Looks up the history of the specified .

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment[], protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Environment]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using lookupEnvironmentHistoryAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

lookupEnvironmentHistory(request, options, callback)

lookupEnvironmentHistory(request: protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>
Returns
TypeDescription
void

lookupEnvironmentHistory(request, callback)

lookupEnvironmentHistory(request: protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest
callback PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>
Returns
TypeDescription
void

lookupEnvironmentHistoryAsync(request, options)

lookupEnvironmentHistoryAsync(request?: protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>;

Equivalent to lookupEnvironmentHistory, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Environment]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. Resource name of the environment to look up the history for.
   *  Format: `projects/

lookupEnvironmentHistoryStream(request, options)

lookupEnvironmentHistoryStream(request?: protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ILookupEnvironmentHistoryRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Environment] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using lookupEnvironmentHistoryAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchAgentFromAgentName(agentName)

matchAgentFromAgentName(agentName: string): string | number;

Parse the agent from Agent resource.

Parameter
NameDescription
agentName string

A fully-qualified path representing Agent resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromAgentValidationResultName(agentValidationResultName)

matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the agent from AgentValidationResult resource.

Parameter
NameDescription
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromChangelogName(changelogName)

matchAgentFromChangelogName(changelogName: string): string | number;

Parse the agent from Changelog resource.

Parameter
NameDescription
changelogName string

A fully-qualified path representing Changelog resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromContinuousTestResultName(continuousTestResultName)

matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the agent from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromDeploymentName(deploymentName)

matchAgentFromDeploymentName(deploymentName: string): string | number;

Parse the agent from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromEntityTypeName(entityTypeName)

matchAgentFromEntityTypeName(entityTypeName: string): string | number;

Parse the agent from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromEnvironmentName(environmentName)

matchAgentFromEnvironmentName(environmentName: string): string | number;

Parse the agent from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromExperimentName(experimentName)

matchAgentFromExperimentName(experimentName: string): string | number;

Parse the agent from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromFlowName(flowName)

matchAgentFromFlowName(flowName: string): string | number;

Parse the agent from Flow resource.

Parameter
NameDescription
flowName string

A fully-qualified path representing Flow resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromFlowValidationResultName(flowValidationResultName)

matchAgentFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the agent from FlowValidationResult resource.

Parameter
NameDescription
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromIntentName(intentName)

matchAgentFromIntentName(intentName: string): string | number;

Parse the agent from Intent resource.

Parameter
NameDescription
intentName string

A fully-qualified path representing Intent resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromPageName(pageName)

matchAgentFromPageName(pageName: string): string | number;

Parse the agent from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromTestCaseName(testCaseName)

matchAgentFromTestCaseName(testCaseName: string): string | number;

Parse the agent from TestCase resource.

Parameter
NameDescription
testCaseName string

A fully-qualified path representing TestCase resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromTestCaseResultName(testCaseResultName)

matchAgentFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the agent from TestCaseResult resource.

Parameter
NameDescription
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromTransitionRouteGroupName(transitionRouteGroupName)

matchAgentFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the agent from TransitionRouteGroup resource.

Parameter
NameDescription
transitionRouteGroupName string

A fully-qualified path representing TransitionRouteGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromVersionName(versionName)

matchAgentFromVersionName(versionName: string): string | number;

Parse the agent from Version resource.

Parameter
NameDescription
versionName string

A fully-qualified path representing Version resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromWebhookName(webhookName)

matchAgentFromWebhookName(webhookName: string): string | number;

Parse the agent from Webhook resource.

Parameter
NameDescription
webhookName string

A fully-qualified path representing Webhook resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchChangelogFromChangelogName(changelogName)

matchChangelogFromChangelogName(changelogName: string): string | number;

Parse the changelog from Changelog resource.

Parameter
NameDescription
changelogName string

A fully-qualified path representing Changelog resource.

Returns
TypeDescription
string | number

{string} A string representing the changelog.

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName)

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the continuous_test_result from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the continuous_test_result.

matchDeploymentFromDeploymentName(deploymentName)

matchDeploymentFromDeploymentName(deploymentName: string): string | number;

Parse the deployment from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the deployment.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEnvironmentFromContinuousTestResultName(continuousTestResultName)

matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the environment from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromDeploymentName(deploymentName)

matchEnvironmentFromDeploymentName(deploymentName: string): string | number;

Parse the environment from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromExperimentName(experimentName)

matchEnvironmentFromExperimentName(experimentName: string): string | number;

Parse the environment from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchExperimentFromExperimentName(experimentName)

matchExperimentFromExperimentName(experimentName: string): string | number;

Parse the experiment from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchFlowFromFlowName(flowName)

matchFlowFromFlowName(flowName: string): string | number;

Parse the flow from Flow resource.

Parameter
NameDescription
flowName string

A fully-qualified path representing Flow resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchFlowFromFlowValidationResultName(flowValidationResultName)

matchFlowFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the flow from FlowValidationResult resource.

Parameter
NameDescription
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchFlowFromPageName(pageName)

matchFlowFromPageName(pageName: string): string | number;

Parse the flow from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchFlowFromTransitionRouteGroupName(transitionRouteGroupName)

matchFlowFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the flow from TransitionRouteGroup resource.

Parameter
NameDescription
transitionRouteGroupName string

A fully-qualified path representing TransitionRouteGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchFlowFromVersionName(versionName)

matchFlowFromVersionName(versionName: string): string | number;

Parse the flow from Version resource.

Parameter
NameDescription
versionName string

A fully-qualified path representing Version resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchIntentFromIntentName(intentName)

matchIntentFromIntentName(intentName: string): string | number;

Parse the intent from Intent resource.

Parameter
NameDescription
intentName string

A fully-qualified path representing Intent resource.

Returns
TypeDescription
string | number

{string} A string representing the intent.

matchLocationFromAgentName(agentName)

matchLocationFromAgentName(agentName: string): string | number;

Parse the location from Agent resource.

Parameter
NameDescription
agentName string

A fully-qualified path representing Agent resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromAgentValidationResultName(agentValidationResultName)

matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the location from AgentValidationResult resource.

Parameter
NameDescription
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromChangelogName(changelogName)

matchLocationFromChangelogName(changelogName: string): string | number;

Parse the location from Changelog resource.

Parameter
NameDescription
changelogName string

A fully-qualified path representing Changelog resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromContinuousTestResultName(continuousTestResultName)

matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the location from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDeploymentName(deploymentName)

matchLocationFromDeploymentName(deploymentName: string): string | number;

Parse the location from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

Parse the location from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromExperimentName(experimentName)

matchLocationFromExperimentName(experimentName: string): string | number;

Parse the location from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromFlowName(flowName)

matchLocationFromFlowName(flowName: string): string | number;

Parse the location from Flow resource.

Parameter
NameDescription
flowName string

A fully-qualified path representing Flow resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromFlowValidationResultName(flowValidationResultName)

matchLocationFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the location from FlowValidationResult resource.

Parameter
NameDescription
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromIntentName(intentName)

matchLocationFromIntentName(intentName: string): string | number;

Parse the location from Intent resource.

Parameter
NameDescription
intentName string

A fully-qualified path representing Intent resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromPageName(pageName)

matchLocationFromPageName(pageName: string): string | number;

Parse the location from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSecuritySettingsName(securitySettingsName)

matchLocationFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the location from SecuritySettings resource.

Parameter
NameDescription
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTestCaseName(testCaseName)

matchLocationFromTestCaseName(testCaseName: string): string | number;

Parse the location from TestCase resource.

Parameter
NameDescription
testCaseName string

A fully-qualified path representing TestCase resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTestCaseResultName(testCaseResultName)

matchLocationFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the location from TestCaseResult resource.

Parameter
NameDescription
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTransitionRouteGroupName(transitionRouteGroupName)

matchLocationFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the location from TransitionRouteGroup resource.

Parameter
NameDescription
transitionRouteGroupName string

A fully-qualified path representing TransitionRouteGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromVersionName(versionName)

matchLocationFromVersionName(versionName: string): string | number;

Parse the location from Version resource.

Parameter
NameDescription
versionName string

A fully-qualified path representing Version resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromWebhookName(webhookName)

matchLocationFromWebhookName(webhookName: string): string | number;

Parse the location from Webhook resource.

Parameter
NameDescription
webhookName string

A fully-qualified path representing Webhook resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchPageFromPageName(pageName)

matchPageFromPageName(pageName: string): string | number;

Parse the page from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the page.

matchProjectFromAgentName(agentName)

matchProjectFromAgentName(agentName: string): string | number;

Parse the project from Agent resource.

Parameter
NameDescription
agentName string

A fully-qualified path representing Agent resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromAgentValidationResultName(agentValidationResultName)

matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the project from AgentValidationResult resource.

Parameter
NameDescription
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromChangelogName(changelogName)

matchProjectFromChangelogName(changelogName: string): string | number;

Parse the project from Changelog resource.

Parameter
NameDescription
changelogName string

A fully-qualified path representing Changelog resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromContinuousTestResultName(continuousTestResultName)

matchProjectFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the project from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDeploymentName(deploymentName)

matchProjectFromDeploymentName(deploymentName: string): string | number;

Parse the project from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

Parse the project from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromExperimentName(experimentName)

matchProjectFromExperimentName(experimentName: string): string | number;

Parse the project from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromFlowName(flowName)

matchProjectFromFlowName(flowName: string): string | number;

Parse the project from Flow resource.

Parameter
NameDescription
flowName string

A fully-qualified path representing Flow resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromFlowValidationResultName(flowValidationResultName)

matchProjectFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the project from FlowValidationResult resource.

Parameter
NameDescription
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromIntentName(intentName)

matchProjectFromIntentName(intentName: string): string | number;

Parse the project from Intent resource.

Parameter
NameDescription
intentName string

A fully-qualified path representing Intent resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromPageName(pageName)

matchProjectFromPageName(pageName: string): string | number;

Parse the project from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromSecuritySettingsName(securitySettingsName)

matchProjectFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the project from SecuritySettings resource.

Parameter
NameDescription
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTestCaseName(testCaseName)

matchProjectFromTestCaseName(testCaseName: string): string | number;

Parse the project from TestCase resource.

Parameter
NameDescription
testCaseName string

A fully-qualified path representing TestCase resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTestCaseResultName(testCaseResultName)

matchProjectFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the project from TestCaseResult resource.

Parameter
NameDescription
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTransitionRouteGroupName(transitionRouteGroupName)

matchProjectFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the project from TransitionRouteGroup resource.

Parameter
NameDescription
transitionRouteGroupName string

A fully-qualified path representing TransitionRouteGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromVersionName(versionName)

matchProjectFromVersionName(versionName: string): string | number;

Parse the project from Version resource.

Parameter
NameDescription
versionName string

A fully-qualified path representing Version resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromWebhookName(webhookName)

matchProjectFromWebhookName(webhookName: string): string | number;

Parse the project from Webhook resource.

Parameter
NameDescription
webhookName string

A fully-qualified path representing Webhook resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchResultFromTestCaseResultName(testCaseResultName)

matchResultFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the result from TestCaseResult resource.

Parameter
NameDescription
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.

Returns
TypeDescription
string | number

{string} A string representing the result.

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName)

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the security_settings from SecuritySettings resource.

Parameter
NameDescription
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.

Returns
TypeDescription
string | number

{string} A string representing the security_settings.

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchTestCaseFromTestCaseName(testCaseName)

matchTestCaseFromTestCaseName(testCaseName: string): string | number;

Parse the test_case from TestCase resource.

Parameter
NameDescription
testCaseName string

A fully-qualified path representing TestCase resource.

Returns
TypeDescription
string | number

{string} A string representing the test_case.

matchTestCaseFromTestCaseResultName(testCaseResultName)

matchTestCaseFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the test_case from TestCaseResult resource.

Parameter
NameDescription
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.

Returns
TypeDescription
string | number

{string} A string representing the test_case.

matchTransitionRouteGroupFromTransitionRouteGroupName(transitionRouteGroupName)

matchTransitionRouteGroupFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the transition_route_group from TransitionRouteGroup resource.

Parameter
NameDescription
transitionRouteGroupName string

A fully-qualified path representing TransitionRouteGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the transition_route_group.

matchVersionFromVersionName(versionName)

matchVersionFromVersionName(versionName: string): string | number;

Parse the version from Version resource.

Parameter
NameDescription
versionName string

A fully-qualified path representing Version resource.

Returns
TypeDescription
string | number

{string} A string representing the version.

matchWebhookFromWebhookName(webhookName)

matchWebhookFromWebhookName(webhookName: string): string | number;

Parse the webhook from Webhook resource.

Parameter
NameDescription
webhookName string

A fully-qualified path representing Webhook resource.

Returns
TypeDescription
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
NameDescription
project string
location string
agent string
flow string
page string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
environment string
session string
entityType string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
session string
entityType string
Returns
TypeDescription
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

runContinuousTest(request, options)

runContinuousTest(request?: protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Kicks off a continuous test under the specified .

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: - response:
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestMetadata>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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: `projects/

runContinuousTest(request, options, callback)

runContinuousTest(request: protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

runContinuousTest(request, callback)

runContinuousTest(request: protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestRequest
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestResponse, protos.google.cloud.dialogflow.cx.v3beta1.IRunContinuousTestMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

securitySettingsPath(project, location, securitySettings)

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

Return a fully-qualified securitySettings resource name string.

Parameters
NameDescription
project string
location string
securitySettings string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
testCase string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
testCase string
result string
Returns
TypeDescription
string

{string} Resource name string.

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

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

Return a fully-qualified transitionRouteGroup resource name string.

Parameters
NameDescription
project string
location string
agent string
flow string
transitionRouteGroup string
Returns
TypeDescription
string

{string} Resource name string.

updateEnvironment(request, options)

updateEnvironment(request?: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateEnvironmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the specified .

This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

  • metadata: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - response:
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IUpdateEnvironmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 environment to update.
   */
  // const environment = {}
  /**
   *  Required. The mask to control which fields get updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateEnvironment() {
    // Construct request
    const request = {
      environment,
      updateMask,
    };

    // Run request
    const [operation] = await cxClient.updateEnvironment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateEnvironment();

updateEnvironment(request, options, callback)

updateEnvironment(request: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateEnvironmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IUpdateEnvironmentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateEnvironment(request, callback)

updateEnvironment(request: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateEnvironmentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IUpdateEnvironmentRequest
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IEnvironment, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
flow string
version string
Returns
TypeDescription
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
NameDescription
project string
location string
agent string
webhook string
Returns
TypeDescription
string

{string} Resource name string.