EnvironmentsClient

EnvironmentsClient

Service for managing Environments.

Constructor

new EnvironmentsClient(optionsopt, gaxInstanceopt)

Construct an instance of EnvironmentsClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new EnvironmentsClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

agentGenerativeSettingsPath(project, location, agent) → {string}

Return a fully-qualified agentGenerativeSettings resource name string.

Parameters:
Name Type Description
project string
location string
agent string
Returns:
Type Description
string

Resource name string.

agentPath(project, location, agent) → {string}

Return a fully-qualified agent resource name string.

Parameters:
Name Type Description
project string
location string
agent string
Returns:
Type Description
string

Resource name string.

agentValidationResultPath(project, location, agent) → {string}

Return a fully-qualified agentValidationResult resource name string.

Parameters:
Name Type Description
project string
location string
agent string
Returns:
Type Description
string

Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

changelogPath(project, location, agent, changelog) → {string}

Return a fully-qualified changelog resource name string.

Parameters:
Name Type Description
project string
location string
agent string
changelog string
Returns:
Type Description
string

Resource name string.

(async) checkCreateEnvironmentProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Agent google.cloud.dialogflow.cx.v3beta1.Agent  to create
   *  an Environment google.cloud.dialogflow.cx.v3beta1.Environment  for.
   *  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The environment to create.
   */
  // const environment = {}

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

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

  async function callCreateEnvironment() {
    // Construct request
    const request = {
      parent,
      environment,
    };

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

  callCreateEnvironment();

(async) checkDeployFlowProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The environment to deploy the flow to.
   *  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
   *  environments/<Environment ID>`.
   */
  // const environment = 'abc123'
  /**
   *  Required. The flow version to deploy.
   *  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
   *  flows/<Flow ID>/versions/<Version ID>`.
   */
  // const flowVersion = 'abc123'

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

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

  async function callDeployFlow() {
    // Construct request
    const request = {
      environment,
      flowVersion,
    };

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

  callDeployFlow();

(async) checkRunContinuousTestProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Format: `projects/<Project ID>/locations/<Location
   *  ID>/agents/<Agent ID>/environments/<Environment ID>`.
   */
  // const environment = 'abc123'

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

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

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

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

  callRunContinuousTest();

(async) checkUpdateEnvironmentProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The 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() → {Promise}

Terminate the gRPC channel and close the client.

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

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

continuousTestResultPath(project, location, agent, environment, continuous_test_result) → {string}

Return a fully-qualified continuousTestResult resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
continuous_test_result string
Returns:
Type Description
string

Resource name string.

conversationPath(project, location, agent, conversation) → {string}

Return a fully-qualified conversation resource name string.

Parameters:
Name Type Description
project string
location string
agent string
conversation string
Returns:
Type Description
string

Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

deploymentPath(project, location, agent, environment, deployment) → {string}

Return a fully-qualified deployment resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
deployment string
Returns:
Type Description
string

Resource name string.

entityTypePath(project, location, agent, entity_type) → {string}

Return a fully-qualified entityType resource name string.

Parameters:
Name Type Description
project string
location string
agent string
entity_type string
Returns:
Type Description
string

Resource name string.

environmentPath(project, location, agent, environment) → {string}

Return a fully-qualified environment resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
Returns:
Type Description
string

Resource name string.

examplePath(project, location, agent, playbook, example) → {string}

Return a fully-qualified example resource name string.

Parameters:
Name Type Description
project string
location string
agent string
playbook string
example string
Returns:
Type Description
string

Resource name string.

experimentPath(project, location, agent, environment, experiment) → {string}

Return a fully-qualified experiment resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
experiment string
Returns:
Type Description
string

Resource name string.

flowPath(project, location, agent, flow) → {string}

Return a fully-qualified flow resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
Returns:
Type Description
string

Resource name string.

flowValidationResultPath(project, location, agent, flow) → {string}

Return a fully-qualified flowValidationResult resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
Returns:
Type Description
string

Resource name string.

generatorPath(project, location, agent, generator) → {string}

Return a fully-qualified generator resource name string.

Parameters:
Name Type Description
project string
location string
agent string
generator string
Returns:
Type Description
string

Resource name string.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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.
Returns:
Type Description
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.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

intentPath(project, location, agent, intent) → {string}

Return a fully-qualified intent resource name string.

Parameters:
Name Type Description
project string
location string
agent string
intent string
Returns:
Type Description
string

Resource name string.

listContinuousTestResultsAsync(request, optionsopt) → {Object}

Equivalent to listContinuousTestResults, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.
pageSize number

The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken string

The next_page_token value returned from a previous list request.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
   *  environments/<Environment ID>`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return in a single page. By default 100 and
   *  at most 1000.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous list request.
   */
  // const pageToken = 'abc123'

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

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

  async function callListContinuousTestResults() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = cxClient.listContinuousTestResultsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListContinuousTestResults();

listContinuousTestResultsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.
pageSize number

The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken string

The next_page_token value returned from a previous list request.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

listEnvironmentsAsync(request, optionsopt) → {Object}

Equivalent to listEnvironments, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The Agent to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageSize number

The maximum number of items to return in a single page. By default 20 and at most 100.
pageToken string

The next_page_token value returned from a previous list request.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 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/<Project ID>/locations/<Location
   *  ID>/agents/<Agent ID>`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return in a single page. By default 20 and
   *  at most 100.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous list request.
   */
  // const pageToken = 'abc123'

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

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

  async function callListEnvironments() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = cxClient.listEnvironmentsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListEnvironments();

listEnvironmentsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The Agent to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageSize number

The maximum number of items to return in a single page. By default 20 and at most 100.
pageToken string

The next_page_token value returned from a previous list request.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 for more details and examples.
Example
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:
Name Type Description
project string
location string
Returns:
Type Description
string

Resource name string.

lookupEnvironmentHistoryAsync(request, optionsopt) → {Object}

Equivalent to lookupEnvironmentHistory, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
pageSize number

The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken string

The next_page_token value returned from a previous list request.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 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/<Project ID>/locations/<Location ID>/agents/<Agent
   *  ID>/environments/<Environment ID>`.
   */
  // const name = 'abc123'
  /**
   *  The maximum number of items to return in a single page. By default 100 and
   *  at most 1000.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous list request.
   */
  // const pageToken = 'abc123'

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

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

  async function callLookupEnvironmentHistory() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const iterable = cxClient.lookupEnvironmentHistoryAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callLookupEnvironmentHistory();

lookupEnvironmentHistoryStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
pageSize number

The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken string

The next_page_token value returned from a previous list request.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName) → {string}

Parse the agent from AgentGenerativeSettings resource.

Parameters:
Name Type Description
agentGenerativeSettingsName string

A fully-qualified path representing AgentGenerativeSettings resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromAgentName(agentName) → {string}

Parse the agent from Agent resource.

Parameters:
Name Type Description
agentName string

A fully-qualified path representing Agent resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromAgentValidationResultName(agentValidationResultName) → {string}

Parse the agent from AgentValidationResult resource.

Parameters:
Name Type Description
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromChangelogName(changelogName) → {string}

Parse the agent from Changelog resource.

Parameters:
Name Type Description
changelogName string

A fully-qualified path representing Changelog resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the agent from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromConversationName(conversationName) → {string}

Parse the agent from Conversation resource.

Parameters:
Name Type Description
conversationName string

A fully-qualified path representing Conversation resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromDeploymentName(deploymentName) → {string}

Parse the agent from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromEntityTypeName(entityTypeName) → {string}

Parse the agent from EntityType resource.

Parameters:
Name Type Description
entityTypeName string

A fully-qualified path representing EntityType resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromEnvironmentName(environmentName) → {string}

Parse the agent from Environment resource.

Parameters:
Name Type Description
environmentName string

A fully-qualified path representing Environment resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromExampleName(exampleName) → {string}

Parse the agent from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromExperimentName(experimentName) → {string}

Parse the agent from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromFlowName(flowName) → {string}

Parse the agent from Flow resource.

Parameters:
Name Type Description
flowName string

A fully-qualified path representing Flow resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromFlowValidationResultName(flowValidationResultName) → {string}

Parse the agent from FlowValidationResult resource.

Parameters:
Name Type Description
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromGeneratorName(generatorName) → {string}

Parse the agent from Generator resource.

Parameters:
Name Type Description
generatorName string

A fully-qualified path representing Generator resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromIntentName(intentName) → {string}

Parse the agent from Intent resource.

Parameters:
Name Type Description
intentName string

A fully-qualified path representing Intent resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromPageName(pageName) → {string}

Parse the agent from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromPlaybookName(playbookName) → {string}

Parse the agent from Playbook resource.

Parameters:
Name Type Description
playbookName string

A fully-qualified path representing Playbook resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromPlaybookVersionName(playbookVersionName) → {string}

Parse the agent from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the agent from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the agent from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName) → {string}

Parse the agent from ProjectLocationAgentTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_transition_route_group resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromTestCaseName(testCaseName) → {string}

Parse the agent from TestCase resource.

Parameters:
Name Type Description
testCaseName string

A fully-qualified path representing TestCase resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromTestCaseResultName(testCaseResultName) → {string}

Parse the agent from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromToolName(toolName) → {string}

Parse the agent from Tool resource.

Parameters:
Name Type Description
toolName string

A fully-qualified path representing Tool resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromVersionName(versionName) → {string}

Parse the agent from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the agent.

matchAgentFromWebhookName(webhookName) → {string}

Parse the agent from Webhook resource.

Parameters:
Name Type Description
webhookName string

A fully-qualified path representing Webhook resource.
Returns:
Type Description
string

A string representing the agent.

matchChangelogFromChangelogName(changelogName) → {string}

Parse the changelog from Changelog resource.

Parameters:
Name Type Description
changelogName string

A fully-qualified path representing Changelog resource.
Returns:
Type Description
string

A string representing the changelog.

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the continuous_test_result from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the continuous_test_result.

matchConversationFromConversationName(conversationName) → {string}

Parse the conversation from Conversation resource.

Parameters:
Name Type Description
conversationName string

A fully-qualified path representing Conversation resource.
Returns:
Type Description
string

A string representing the conversation.

matchDeploymentFromDeploymentName(deploymentName) → {string}

Parse the deployment from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the deployment.

matchEntityTypeFromEntityTypeName(entityTypeName) → {string}

Parse the entity_type from EntityType resource.

Parameters:
Name Type Description
entityTypeName string

A fully-qualified path representing EntityType resource.
Returns:
Type Description
string

A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the entity_type.

matchEnvironmentFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the environment from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromDeploymentName(deploymentName) → {string}

Parse the environment from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromEnvironmentName(environmentName) → {string}

Parse the environment from Environment resource.

Parameters:
Name Type Description
environmentName string

A fully-qualified path representing Environment resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromExperimentName(experimentName) → {string}

Parse the environment from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the environment.

matchExampleFromExampleName(exampleName) → {string}

Parse the example from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the example.

matchExperimentFromExperimentName(experimentName) → {string}

Parse the experiment from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the experiment.

matchFlowFromFlowName(flowName) → {string}

Parse the flow from Flow resource.

Parameters:
Name Type Description
flowName string

A fully-qualified path representing Flow resource.
Returns:
Type Description
string

A string representing the flow.

matchFlowFromFlowValidationResultName(flowValidationResultName) → {string}

Parse the flow from FlowValidationResult resource.

Parameters:
Name Type Description
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.
Returns:
Type Description
string

A string representing the flow.

matchFlowFromPageName(pageName) → {string}

Parse the flow from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the flow.

matchFlowFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the flow from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the flow.

matchFlowFromVersionName(versionName) → {string}

Parse the flow from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the flow.

matchGeneratorFromGeneratorName(generatorName) → {string}

Parse the generator from Generator resource.

Parameters:
Name Type Description
generatorName string

A fully-qualified path representing Generator resource.
Returns:
Type Description
string

A string representing the generator.

matchIntentFromIntentName(intentName) → {string}

Parse the intent from Intent resource.

Parameters:
Name Type Description
intentName string

A fully-qualified path representing Intent resource.
Returns:
Type Description
string

A string representing the intent.

matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName) → {string}

Parse the location from AgentGenerativeSettings resource.

Parameters:
Name Type Description
agentGenerativeSettingsName string

A fully-qualified path representing AgentGenerativeSettings resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromAgentName(agentName) → {string}

Parse the location from Agent resource.

Parameters:
Name Type Description
agentName string

A fully-qualified path representing Agent resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromAgentValidationResultName(agentValidationResultName) → {string}

Parse the location from AgentValidationResult resource.

Parameters:
Name Type Description
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromChangelogName(changelogName) → {string}

Parse the location from Changelog resource.

Parameters:
Name Type Description
changelogName string

A fully-qualified path representing Changelog resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the location from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromConversationName(conversationName) → {string}

Parse the location from Conversation resource.

Parameters:
Name Type Description
conversationName string

A fully-qualified path representing Conversation resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromDeploymentName(deploymentName) → {string}

Parse the location from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromEntityTypeName(entityTypeName) → {string}

Parse the location from EntityType resource.

Parameters:
Name Type Description
entityTypeName string

A fully-qualified path representing EntityType resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromEnvironmentName(environmentName) → {string}

Parse the location from Environment resource.

Parameters:
Name Type Description
environmentName string

A fully-qualified path representing Environment resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromExampleName(exampleName) → {string}

Parse the location from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromExperimentName(experimentName) → {string}

Parse the location from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFlowName(flowName) → {string}

Parse the location from Flow resource.

Parameters:
Name Type Description
flowName string

A fully-qualified path representing Flow resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFlowValidationResultName(flowValidationResultName) → {string}

Parse the location from FlowValidationResult resource.

Parameters:
Name Type Description
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromGeneratorName(generatorName) → {string}

Parse the location from Generator resource.

Parameters:
Name Type Description
generatorName string

A fully-qualified path representing Generator resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromIntentName(intentName) → {string}

Parse the location from Intent resource.

Parameters:
Name Type Description
intentName string

A fully-qualified path representing Intent resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPageName(pageName) → {string}

Parse the location from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPlaybookName(playbookName) → {string}

Parse the location from Playbook resource.

Parameters:
Name Type Description
playbookName string

A fully-qualified path representing Playbook resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPlaybookVersionName(playbookVersionName) → {string}

Parse the location from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the location from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName) → {string}

Parse the location from ProjectLocationAgentTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_transition_route_group resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromSecuritySettingsName(securitySettingsName) → {string}

Parse the location from SecuritySettings resource.

Parameters:
Name Type Description
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTestCaseName(testCaseName) → {string}

Parse the location from TestCase resource.

Parameters:
Name Type Description
testCaseName string

A fully-qualified path representing TestCase resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTestCaseResultName(testCaseResultName) → {string}

Parse the location from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromToolName(toolName) → {string}

Parse the location from Tool resource.

Parameters:
Name Type Description
toolName string

A fully-qualified path representing Tool resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromVersionName(versionName) → {string}

Parse the location from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromWebhookName(webhookName) → {string}

Parse the location from Webhook resource.

Parameters:
Name Type Description
webhookName string

A fully-qualified path representing Webhook resource.
Returns:
Type Description
string

A string representing the location.

matchPageFromPageName(pageName) → {string}

Parse the page from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the page.

matchPlaybookFromExampleName(exampleName) → {string}

Parse the playbook from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the playbook.

matchPlaybookFromPlaybookName(playbookName) → {string}

Parse the playbook from Playbook resource.

Parameters:
Name Type Description
playbookName string

A fully-qualified path representing Playbook resource.
Returns:
Type Description
string

A string representing the playbook.

matchPlaybookFromPlaybookVersionName(playbookVersionName) → {string}

Parse the playbook from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the playbook.

matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName) → {string}

Parse the project from AgentGenerativeSettings resource.

Parameters:
Name Type Description
agentGenerativeSettingsName string

A fully-qualified path representing AgentGenerativeSettings resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromAgentName(agentName) → {string}

Parse the project from Agent resource.

Parameters:
Name Type Description
agentName string

A fully-qualified path representing Agent resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromAgentValidationResultName(agentValidationResultName) → {string}

Parse the project from AgentValidationResult resource.

Parameters:
Name Type Description
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromChangelogName(changelogName) → {string}

Parse the project from Changelog resource.

Parameters:
Name Type Description
changelogName string

A fully-qualified path representing Changelog resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromContinuousTestResultName(continuousTestResultName) → {string}

Parse the project from ContinuousTestResult resource.

Parameters:
Name Type Description
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromConversationName(conversationName) → {string}

Parse the project from Conversation resource.

Parameters:
Name Type Description
conversationName string

A fully-qualified path representing Conversation resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromDeploymentName(deploymentName) → {string}

Parse the project from Deployment resource.

Parameters:
Name Type Description
deploymentName string

A fully-qualified path representing Deployment resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromEntityTypeName(entityTypeName) → {string}

Parse the project from EntityType resource.

Parameters:
Name Type Description
entityTypeName string

A fully-qualified path representing EntityType resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromEnvironmentName(environmentName) → {string}

Parse the project from Environment resource.

Parameters:
Name Type Description
environmentName string

A fully-qualified path representing Environment resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromExampleName(exampleName) → {string}

Parse the project from Example resource.

Parameters:
Name Type Description
exampleName string

A fully-qualified path representing Example resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromExperimentName(experimentName) → {string}

Parse the project from Experiment resource.

Parameters:
Name Type Description
experimentName string

A fully-qualified path representing Experiment resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromFlowName(flowName) → {string}

Parse the project from Flow resource.

Parameters:
Name Type Description
flowName string

A fully-qualified path representing Flow resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromFlowValidationResultName(flowValidationResultName) → {string}

Parse the project from FlowValidationResult resource.

Parameters:
Name Type Description
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromGeneratorName(generatorName) → {string}

Parse the project from Generator resource.

Parameters:
Name Type Description
generatorName string

A fully-qualified path representing Generator resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromIntentName(intentName) → {string}

Parse the project from Intent resource.

Parameters:
Name Type Description
intentName string

A fully-qualified path representing Intent resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPageName(pageName) → {string}

Parse the project from Page resource.

Parameters:
Name Type Description
pageName string

A fully-qualified path representing Page resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPlaybookName(playbookName) → {string}

Parse the project from Playbook resource.

Parameters:
Name Type Description
playbookName string

A fully-qualified path representing Playbook resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPlaybookVersionName(playbookVersionName) → {string}

Parse the project from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the project from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName) → {string}

Parse the project from ProjectLocationAgentTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_transition_route_group resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromSecuritySettingsName(securitySettingsName) → {string}

Parse the project from SecuritySettings resource.

Parameters:
Name Type Description
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTestCaseName(testCaseName) → {string}

Parse the project from TestCase resource.

Parameters:
Name Type Description
testCaseName string

A fully-qualified path representing TestCase resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTestCaseResultName(testCaseResultName) → {string}

Parse the project from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromToolName(toolName) → {string}

Parse the project from Tool resource.

Parameters:
Name Type Description
toolName string

A fully-qualified path representing Tool resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromVersionName(versionName) → {string}

Parse the project from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromWebhookName(webhookName) → {string}

Parse the project from Webhook resource.

Parameters:
Name Type Description
webhookName string

A fully-qualified path representing Webhook resource.
Returns:
Type Description
string

A string representing the project.

matchResultFromTestCaseResultName(testCaseResultName) → {string}

Parse the result from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the result.

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName) → {string}

Parse the security_settings from SecuritySettings resource.

Parameters:
Name Type Description
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.
Returns:
Type Description
string

A string representing the security_settings.

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName) → {string}

Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
Returns:
Type Description
string

A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameters:
Name Type Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns:
Type Description
string

A string representing the session.

matchTestCaseFromTestCaseName(testCaseName) → {string}

Parse the test_case from TestCase resource.

Parameters:
Name Type Description
testCaseName string

A fully-qualified path representing TestCase resource.
Returns:
Type Description
string

A string representing the test_case.

matchTestCaseFromTestCaseResultName(testCaseResultName) → {string}

Parse the test_case from TestCaseResult resource.

Parameters:
Name Type Description
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.
Returns:
Type Description
string

A string representing the test_case.

matchToolFromToolName(toolName) → {string}

Parse the tool from Tool resource.

Parameters:
Name Type Description
toolName string

A fully-qualified path representing Tool resource.
Returns:
Type Description
string

A string representing the tool.

matchTransitionRouteGroupFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName) → {string}

Parse the transition_route_group from ProjectLocationAgentFlowTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentFlowTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
Returns:
Type Description
string

A string representing the transition_route_group.

matchTransitionRouteGroupFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName) → {string}

Parse the transition_route_group from ProjectLocationAgentTransitionRouteGroup resource.

Parameters:
Name Type Description
projectLocationAgentTransitionRouteGroupName string

A fully-qualified path representing project_location_agent_transition_route_group resource.
Returns:
Type Description
string

A string representing the transition_route_group.

matchVersionFromPlaybookVersionName(playbookVersionName) → {string}

Parse the version from PlaybookVersion resource.

Parameters:
Name Type Description
playbookVersionName string

A fully-qualified path representing PlaybookVersion resource.
Returns:
Type Description
string

A string representing the version.

matchVersionFromVersionName(versionName) → {string}

Parse the version from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the version.

matchWebhookFromWebhookName(webhookName) → {string}

Parse the webhook from Webhook resource.

Parameters:
Name Type Description
webhookName string

A fully-qualified path representing Webhook resource.
Returns:
Type Description
string

A string representing the webhook.

pagePath(project, location, agent, flow, page) → {string}

Return a fully-qualified page resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
page string
Returns:
Type Description
string

Resource name string.

playbookPath(project, location, agent, playbook) → {string}

Return a fully-qualified playbook resource name string.

Parameters:
Name Type Description
project string
location string
agent string
playbook string
Returns:
Type Description
string

Resource name string.

playbookVersionPath(project, location, agent, playbook, version) → {string}

Return a fully-qualified playbookVersion resource name string.

Parameters:
Name Type Description
project string
location string
agent string
playbook string
version string
Returns:
Type Description
string

Resource name string.

projectLocationAgentEnvironmentSessionEntityTypePath(project, location, agent, environment, session, entity_type) → {string}

Return a fully-qualified projectLocationAgentEnvironmentSessionEntityType resource name string.

Parameters:
Name Type Description
project string
location string
agent string
environment string
session string
entity_type string
Returns:
Type Description
string

Resource name string.

projectLocationAgentFlowTransitionRouteGroupPath(project, location, agent, flow, transition_route_group) → {string}

Return a fully-qualified projectLocationAgentFlowTransitionRouteGroup resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
transition_route_group string
Returns:
Type Description
string

Resource name string.

projectLocationAgentSessionEntityTypePath(project, location, agent, session, entity_type) → {string}

Return a fully-qualified projectLocationAgentSessionEntityType resource name string.

Parameters:
Name Type Description
project string
location string
agent string
session string
entity_type string
Returns:
Type Description
string

Resource name string.

projectLocationAgentTransitionRouteGroupPath(project, location, agent, transition_route_group) → {string}

Return a fully-qualified projectLocationAgentTransitionRouteGroup resource name string.

Parameters:
Name Type Description
project string
location string
agent string
transition_route_group string
Returns:
Type Description
string

Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

securitySettingsPath(project, location, security_settings) → {string}

Return a fully-qualified securitySettings resource name string.

Parameters:
Name Type Description
project string
location string
security_settings string
Returns:
Type Description
string

Resource name string.

testCasePath(project, location, agent, test_case) → {string}

Return a fully-qualified testCase resource name string.

Parameters:
Name Type Description
project string
location string
agent string
test_case string
Returns:
Type Description
string

Resource name string.

testCaseResultPath(project, location, agent, test_case, result) → {string}

Return a fully-qualified testCaseResult resource name string.

Parameters:
Name Type Description
project string
location string
agent string
test_case string
result string
Returns:
Type Description
string

Resource name string.

toolPath(project, location, agent, tool) → {string}

Return a fully-qualified tool resource name string.

Parameters:
Name Type Description
project string
location string
agent string
tool string
Returns:
Type Description
string

Resource name string.

versionPath(project, location, agent, flow, version) → {string}

Return a fully-qualified version resource name string.

Parameters:
Name Type Description
project string
location string
agent string
flow string
version string
Returns:
Type Description
string

Resource name string.

webhookPath(project, location, agent, webhook) → {string}

Return a fully-qualified webhook resource name string.

Parameters:
Name Type Description
project string
location string
agent string
webhook string
Returns:
Type Description
string

Resource name string.