@google-cloud/dialogflow-cx
Version:
1,024 lines • 113 kB
JavaScript
"use strict";
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
Object.defineProperty(exports, "__esModule", { value: true });
exports.WebhooksClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v3beta1/webhooks_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./webhooks_client_config.json");
const version = require('../../../package.json').version;
/**
* Service for managing {@link protos.google.cloud.dialogflow.cx.v3beta1.Webhook|Webhooks}.
* @class
* @memberof v3beta1
*/
class WebhooksClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('dialogflow-cx');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
locationsClient;
pathTemplates;
webhooksStub;
/**
* Construct an instance of WebhooksClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new WebhooksClient({fallback: true}, gax);
* ```
*/
constructor(opts, gaxInstance) {
// Ensure that options include all the required fields.
const staticMembers = this.constructor;
if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
throw new Error('Please set either universe_domain or universeDomain, but not both.');
}
const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
this._servicePath = 'dialogflow.' + this._universeDomain;
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
// Request numeric enum values if REST transport is used.
opts.numericEnums = true;
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== this._servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Load google-gax module synchronously if needed
if (!gaxInstance) {
gaxInstance = require('google-gax');
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth;
// Set useJWTAccessWithScope on the auth object.
this.auth.useJWTAccessWithScope = true;
// Set defaultServicePath on the auth object.
this.auth.defaultServicePath = this._servicePath;
// Set the default scopes in auth client if needed.
if (servicePath === this._servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
// Determine the client header string.
const clientHeader = [
`gax/${this._gaxModule.version}`,
`gapic/${version}`,
];
if (typeof process === 'object' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// This API contains "path templates"; forward-slash-separated
// identifiers to uniquely identify resources within the API.
// Create useful helper objects for these.
this.pathTemplates = {
agentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}'),
agentGenerativeSettingsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/generativeSettings'),
agentValidationResultPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/validationResult'),
changelogPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/changelogs/{changelog}'),
continuousTestResultPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/continuousTestResults/{continuous_test_result}'),
conversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/conversations/{conversation}'),
deploymentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment}'),
entityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/entityTypes/{entity_type}'),
environmentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/environments/{environment}'),
examplePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}/examples/{example}'),
experimentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/experiments/{experiment}'),
flowPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/flows/{flow}'),
flowValidationResultPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult'),
generatorPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/generators/{generator}'),
intentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/intents/{intent}'),
locationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}'),
pagePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/pages/{page}'),
playbookPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}'),
playbookVersionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}/versions/{version}'),
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
projectLocationAgentEnvironmentSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}'),
projectLocationAgentEnvironmentSessionEntityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}'),
projectLocationAgentFlowTransitionRouteGroupsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group}'),
projectLocationAgentSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/sessions/{session}'),
projectLocationAgentSessionEntityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}'),
projectLocationAgentTransitionRouteGroupsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/transitionRouteGroups/{transition_route_group}'),
securitySettingsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/securitySettings/{security_settings}'),
testCasePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}'),
testCaseResultPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/testCases/{test_case}/results/{result}'),
toolPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/tools/{tool}'),
toolVersionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}'),
versionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/versions/{version}'),
webhookPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}'),
};
// Some of the methods on this service return "paged" results,
// (e.g. 50 results at a time, with tokens to get subsequent
// pages). Denote the keys used for pagination and results.
this.descriptors.page = {
listWebhooks: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'webhooks')
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.dialogflow.cx.v3beta1.Webhooks', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = this._gaxModule.warn;
}
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize() {
// If the client stub promise is already initialized, return immediately.
if (this.webhooksStub) {
return this.webhooksStub;
}
// Put together the "service stub" for
// google.cloud.dialogflow.cx.v3beta1.Webhooks.
this.webhooksStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.cloud.dialogflow.cx.v3beta1.Webhooks') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.dialogflow.cx.v3beta1.Webhooks, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const webhooksStubMethods = ['listWebhooks', 'getWebhook', 'createWebhook', 'updateWebhook', 'deleteWebhook'];
for (const methodName of webhooksStubMethods) {
const callPromise = this.webhooksStub.then(stub => (...args) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
}, (err) => () => {
throw err;
});
const descriptor = this.descriptors.page[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.webhooksStub;
}
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'dialogflow.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'dialogflow.googleapis.com';
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint() {
return this._servicePath;
}
get universeDomain() {
return this._universeDomain;
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/cloud-platform',
'https://www.googleapis.com/auth/dialogflow'
];
}
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(callback) {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
getWebhook(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getWebhook request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getWebhook response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getWebhook(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getWebhook response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
createWebhook(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('createWebhook request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('createWebhook response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.createWebhook(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('createWebhook response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
updateWebhook(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'webhook.name': request.webhook.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('updateWebhook request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('updateWebhook response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.updateWebhook(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('updateWebhook response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
deleteWebhook(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('deleteWebhook request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteWebhook response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.deleteWebhook(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteWebhook response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
listWebhooks(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('listWebhooks values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('listWebhooks request %j', request);
return this.innerApiCalls
.listWebhooks(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listWebhooks values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listWebhooks`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The agent to list all webhooks for.
* Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
* @param {number} request.pageSize
* The maximum number of items to return in a single page. By default 100 and
* at most 1000.
* @param {string} request.pageToken
* The next_page_token value returned from a previous list request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.dialogflow.cx.v3beta1.Webhook|Webhook} 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 `listWebhooksAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listWebhooksStream(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
const defaultCallSettings = this._defaults['listWebhooks'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listWebhooks stream %j', request);
return this.descriptors.page.listWebhooks.createStream(this.innerApiCalls.listWebhooks, request, callSettings);
}
/**
* Equivalent to `listWebhooks`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The agent to list all webhooks for.
* Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
* @param {number} request.pageSize
* The maximum number of items to return in a single page. By default 100 and
* at most 1000.
* @param {string} request.pageToken
* The next_page_token value returned from a previous list request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.dialogflow.cx.v3beta1.Webhook|Webhook}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3beta1/webhooks.list_webhooks.js</caption>
* region_tag:dialogflow_v3beta1_generated_Webhooks_ListWebhooks_async
*/
listWebhooksAsync(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
const defaultCallSettings = this._defaults['listWebhooks'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listWebhooks iterate %j', request);
return this.descriptors.page.listWebhooks.asyncIterate(this.innerApiCalls['listWebhooks'], request, callSettings);
}
/**
* Gets information about a location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Resource name for the location.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example
* ```
* const [response] = await client.getLocation(request);
* ```
*/
getLocation(request, options, callback) {
return this.locationsClient.getLocation(request, options, callback);
}
/**
* Lists information about the supported locations for this service. Returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The resource that owns the locations collection, if applicable.
* @param {string} request.filter
* The standard list filter.
* @param {number} request.pageSize
* The standard list page size.
* @param {string} request.pageToken
* The standard list page token.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example
* ```
* const iterable = client.listLocationsAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listLocationsAsync(request, options) {
return this.locationsClient.listLocationsAsync(request, options);
}
// --------------------
// -- Path templates --
// --------------------
/**
* Return a fully-qualified agent resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @returns {string} Resource name string.
*/
agentPath(project, location, agent) {
return this.pathTemplates.agentPathTemplate.render({
project: project,
location: location,
agent: agent,
});
}
/**
* Parse the project from Agent resource.
*
* @param {string} agentName
* A fully-qualified path representing Agent resource.
* @returns {string} A string representing the project.
*/
matchProjectFromAgentName(agentName) {
return this.pathTemplates.agentPathTemplate.match(agentName).project;
}
/**
* Parse the location from Agent resource.
*
* @param {string} agentName
* A fully-qualified path representing Agent resource.
* @returns {string} A string representing the location.
*/
matchLocationFromAgentName(agentName) {
return this.pathTemplates.agentPathTemplate.match(agentName).location;
}
/**
* Parse the agent from Agent resource.
*
* @param {string} agentName
* A fully-qualified path representing Agent resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromAgentName(agentName) {
return this.pathTemplates.agentPathTemplate.match(agentName).agent;
}
/**
* Return a fully-qualified agentGenerativeSettings resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @returns {string} Resource name string.
*/
agentGenerativeSettingsPath(project, location, agent) {
return this.pathTemplates.agentGenerativeSettingsPathTemplate.render({
project: project,
location: location,
agent: agent,
});
}
/**
* Parse the project from AgentGenerativeSettings resource.
*
* @param {string} agentGenerativeSettingsName
* A fully-qualified path representing AgentGenerativeSettings resource.
* @returns {string} A string representing the project.
*/
matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName) {
return this.pathTemplates.agentGenerativeSettingsPathTemplate.match(agentGenerativeSettingsName).project;
}
/**
* Parse the location from AgentGenerativeSettings resource.
*
* @param {string} agentGenerativeSettingsName
* A fully-qualified path representing AgentGenerativeSettings resource.
* @returns {string} A string representing the location.
*/
matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName) {
return this.pathTemplates.agentGenerativeSettingsPathTemplate.match(agentGenerativeSettingsName).location;
}
/**
* Parse the agent from AgentGenerativeSettings resource.
*
* @param {string} agentGenerativeSettingsName
* A fully-qualified path representing AgentGenerativeSettings resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName) {
return this.pathTemplates.agentGenerativeSettingsPathTemplate.match(agentGenerativeSettingsName).agent;
}
/**
* Return a fully-qualified agentValidationResult resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @returns {string} Resource name string.
*/
agentValidationResultPath(project, location, agent) {
return this.pathTemplates.agentValidationResultPathTemplate.render({
project: project,
location: location,
agent: agent,
});
}
/**
* Parse the project from AgentValidationResult resource.
*
* @param {string} agentValidationResultName
* A fully-qualified path representing AgentValidationResult resource.
* @returns {string} A string representing the project.
*/
matchProjectFromAgentValidationResultName(agentValidationResultName) {
return this.pathTemplates.agentValidationResultPathTemplate.match(agentValidationResultName).project;
}
/**
* Parse the location from AgentValidationResult resource.
*
* @param {string} agentValidationResultName
* A fully-qualified path representing AgentValidationResult resource.
* @returns {string} A string representing the location.
*/
matchLocationFromAgentValidationResultName(agentValidationResultName) {
return this.pathTemplates.agentValidationResultPathTemplate.match(agentValidationResultName).location;
}
/**
* Parse the agent from AgentValidationResult resource.
*
* @param {string} agentValidationResultName
* A fully-qualified path representing AgentValidationResult resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromAgentValidationResultName(agentValidationResultName) {
return this.pathTemplates.agentValidationResultPathTemplate.match(agentValidationResultName).agent;
}
/**
* Return a fully-qualified changelog resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} changelog
* @returns {string} Resource name string.
*/
changelogPath(project, location, agent, changelog) {
return this.pathTemplates.changelogPathTemplate.render({
project: project,
location: location,
agent: agent,
changelog: changelog,
});
}
/**
* Parse the project from Changelog resource.
*
* @param {string} changelogName
* A fully-qualified path representing Changelog resource.
* @returns {string} A string representing the project.
*/
matchProjectFromChangelogName(changelogName) {
return this.pathTemplates.changelogPathTemplate.match(changelogName).project;
}
/**
* Parse the location from Changelog resource.
*
* @param {string} changelogName
* A fully-qualified path representing Changelog resource.
* @returns {string} A string representing the location.
*/
matchLocationFromChangelogName(changelogName) {
return this.pathTemplates.changelogPathTemplate.match(changelogName).location;
}
/**
* Parse the agent from Changelog resource.
*
* @param {string} changelogName
* A fully-qualified path representing Changelog resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromChangelogName(changelogName) {
return this.pathTemplates.changelogPathTemplate.match(changelogName).agent;
}
/**
* Parse the changelog from Changelog resource.
*
* @param {string} changelogName
* A fully-qualified path representing Changelog resource.
* @returns {string} A string representing the changelog.
*/
matchChangelogFromChangelogName(changelogName) {
return this.pathTemplates.changelogPathTemplate.match(changelogName).changelog;
}
/**
* Return a fully-qualified continuousTestResult resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} environment
* @param {string} continuous_test_result
* @returns {string} Resource name string.
*/
continuousTestResultPath(project, location, agent, environment, continuousTestResult) {
return this.pathTemplates.continuousTestResultPathTemplate.render({
project: project,
location: location,
agent: agent,
environment: environment,
continuous_test_result: continuousTestResult,
});
}
/**
* Parse the project from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the project.
*/
matchProjectFromContinuousTestResultName(continuousTestResultName) {
return this.pathTemplates.continuousTestResultPathTemplate.match(continuousTestResultName).project;
}
/**
* Parse the location from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the location.
*/
matchLocationFromContinuousTestResultName(continuousTestResultName) {
return this.pathTemplates.continuousTestResultPathTemplate.match(continuousTestResultName).location;
}
/**
* Parse the agent from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromContinuousTestResultName(continuousTestResultName) {
return this.pathTemplates.continuousTestResultPathTemplate.match(continuousTestResultName).agent;
}
/**
* Parse the environment from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromContinuousTestResultName(continuousTestResultName) {
return this.pathTemplates.continuousTestResultPathTemplate.match(continuousTestResultName).environment;
}
/**
* Parse the continuous_test_result from ContinuousTestResult resource.
*
* @param {string} continuousTestResultName
* A fully-qualified path representing ContinuousTestResult resource.
* @returns {string} A string representing the continuous_test_result.
*/
matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName) {
return this.pathTemplates.continuousTestResultPathTemplate.match(continuousTestResultName).continuous_test_result;
}
/**
* Return a fully-qualified conversation resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} conversation
* @returns {string} Resource name string.
*/
conversationPath(project, location, agent, conversation) {
return this.pathTemplates.conversationPathTemplate.render({
project: project,
location: location,
agent: agent,
conversation: conversation,
});
}
/**
* Parse the project from Conversation resource.
*
* @param {string} conversationName
* A fully-qualified path representing Conversation resource.
* @returns {string} A string representing the project.
*/
matchProjectFromConversationName(conversationName) {
return this.pathTemplates.conversationPathTemplate.match(conversationName).project;
}
/**
* Parse the location from Conversation resource.
*
* @param {string} conversationName
* A fully-qualified path representing Conversation resource.
* @returns {string} A string representing the location.
*/
matchLocationFromConversationName(conversationName) {
return this.pathTemplates.conversationPathTemplate.match(conversationName).location;
}
/**
* Parse the agent from Conversation resource.
*
* @param {string} conversationName
* A fully-qualified path representing Conversation resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromConversationName(conversationName) {
return this.pathTemplates.conversationPathTemplate.match(conversationName).agent;
}
/**
* Parse the conversation from Conversation resource.
*
* @param {string} conversationName
* A fully-qualified path representing Conversation resource.
* @returns {string} A string representing the conversation.
*/
matchConversationFromConversationName(conversationName) {
return this.pathTemplates.conversationPathTemplate.match(conversationName).conversation;
}
/**
* Return a fully-qualified deployment resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} environment
* @param {string} deployment
* @returns {string} Resource name string.
*/
deploymentPath(project, location, agent, environment, deployment) {
return this.pathTemplates.deploymentPathTemplate.render({
project: project,
location: location,
agent: agent,
environment: environment,
deployment: deployment,
});
}
/**
* Parse the project from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDeploymentName(deploymentName) {
return this.pathTemplates.deploymentPathTemplate.match(deploymentName).project;
}
/**
* Parse the location from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDeploymentName(deploymentName) {
return this.pathTemplates.deploymentPathTemplate.match(deploymentName).location;
}
/**
* Parse the agent from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the agent.
*/
matchAgentFromDeploymentName(deploymentName) {
return this.pathTemplates.deploymentPathTemplate.match(deploymentName).agent;
}
/**
* Parse the environment from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromDeploymentName(deploymentName) {
return this.pathTemplates.deploymentPathTemplate.match(deploymentName).environment;
}
/**
* Parse the deployment from Deployment resource.
*
* @param {string} deploymentName
* A fully-qualified path representing Deployment resource.
* @returns {string} A string representing the deployment.
*/
matchDeploymentFromDeploymentName(deploymentName) {
return this.pathTemplates.deploymentPathTemplate.match(deploymentName).deployment;
}
/**
* Return a fully-qualified entityType resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} agent
* @param {string} entity_type
* @returns {string} Resource name string.
*/
entityTypePath(project, location, agent, entityType) {
return this.pathTemplates.en