@google-cloud/dialogflow
Version:
Dialogflow API client for Node.js
942 lines • 121 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.EncryptionSpecServiceClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v2beta1/encryption_spec_service_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./encryption_spec_service_client_config.json");
const version = require('../../../package.json').version;
/**
* Manages encryption spec settings for Dialogflow and Agent Assist.
* @class
* @memberof v2beta1
*/
class EncryptionSpecServiceClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('dialogflow');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
locationsClient;
pathTemplates;
operationsClient;
encryptionSpecServiceStub;
/**
* Construct an instance of EncryptionSpecServiceClient.
*
* @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 EncryptionSpecServiceClient({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 = {
encryptionSpecPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/encryptionSpec'),
generatorPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/generators/{generator}'),
projectAgentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent'),
projectAgentEntityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/entityTypes/{entity_type}'),
projectAgentEnvironmentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/environments/{environment}'),
projectAgentEnvironmentUserSessionContextPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}'),
projectAgentEnvironmentUserSessionEntityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}'),
projectAgentFulfillmentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/fulfillment'),
projectAgentIntentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/intents/{intent}'),
projectAgentSessionContextPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/sessions/{session}/contexts/{context}'),
projectAgentSessionEntityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}'),
projectAgentVersionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/agent/versions/{version}'),
projectAnswerRecordPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/answerRecords/{answer_record}'),
projectConversationMessagePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/conversations/{conversation}/messages/{message}'),
projectConversationParticipantPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/conversations/{conversation}/participants/{participant}'),
projectConversationProfilePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/conversationProfiles/{conversation_profile}'),
projectConversationsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/conversations/{conversation}'),
projectKnowledgeBasePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/knowledgeBases/{knowledge_base}'),
projectKnowledgeBaseDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}'),
projectLocationAgentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent'),
projectLocationAgentEntityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/entityTypes/{entity_type}'),
projectLocationAgentEnvironmentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/environments/{environment}'),
projectLocationAgentEnvironmentUserSessionContextPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}'),
projectLocationAgentEnvironmentUserSessionEntityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}'),
projectLocationAgentFulfillmentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/fulfillment'),
projectLocationAgentIntentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/intents/{intent}'),
projectLocationAgentSessionContextPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}'),
projectLocationAgentSessionEntityTypePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}'),
projectLocationAgentVersionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/agent/versions/{version}'),
projectLocationAnswerRecordPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/answerRecords/{answer_record}'),
projectLocationConversationMessagePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}'),
projectLocationConversationParticipantPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}'),
projectLocationConversationProfilePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}'),
projectLocationConversationsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/conversations/{conversation}'),
projectLocationKnowledgeBasePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}'),
projectLocationKnowledgeBaseDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}'),
projectLocationPhoneNumberPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/phoneNumbers/{phone_number}'),
projectPhoneNumberPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/phoneNumbers/{phone_number}'),
sipTrunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sipTrunks/{siptrunk}'),
};
const protoFilesRoot = this._gaxModule.protobufFromJSON(jsonProtos);
// This API contains "long-running operations", which return a
// an Operation object that allows for tracking of the operation,
// rather than holding a request open.
const lroOptions = {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined
};
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [{ selector: 'google.cloud.location.Locations.GetLocation', get: '/v2beta1/{name=projects/*/locations/*}', }, { selector: 'google.cloud.location.Locations.ListLocations', get: '/v2beta1/{name=projects/*}/locations', }, { selector: 'google.longrunning.Operations.CancelOperation', post: '/v2beta1/{name=projects/*/operations/*}:cancel', additional_bindings: [{ post: '/v2beta1/{name=projects/*/locations/*/operations/*}:cancel', }],
}, { selector: 'google.longrunning.Operations.GetOperation', get: '/v2beta1/{name=projects/*/operations/*}', additional_bindings: [{ get: '/v2beta1/{name=projects/*/locations/*/operations/*}', }],
}, { selector: 'google.longrunning.Operations.ListOperations', get: '/v2beta1/{name=projects/*}/operations', additional_bindings: [{ get: '/v2beta1/{name=projects/*/locations/*}/operations', }],
}];
}
this.operationsClient = this._gaxModule.lro(lroOptions).operationsClient(opts);
const initializeEncryptionSpecResponse = protoFilesRoot.lookup('.google.cloud.dialogflow.v2beta1.InitializeEncryptionSpecResponse');
const initializeEncryptionSpecMetadata = protoFilesRoot.lookup('.google.cloud.dialogflow.v2beta1.InitializeEncryptionSpecMetadata');
this.descriptors.longrunning = {
initializeEncryptionSpec: new this._gaxModule.LongrunningDescriptor(this.operationsClient, initializeEncryptionSpecResponse.decode.bind(initializeEncryptionSpecResponse), initializeEncryptionSpecMetadata.decode.bind(initializeEncryptionSpecMetadata))
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.dialogflow.v2beta1.EncryptionSpecService', 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.encryptionSpecServiceStub) {
return this.encryptionSpecServiceStub;
}
// Put together the "service stub" for
// google.cloud.dialogflow.v2beta1.EncryptionSpecService.
this.encryptionSpecServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.cloud.dialogflow.v2beta1.EncryptionSpecService') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.dialogflow.v2beta1.EncryptionSpecService, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const encryptionSpecServiceStubMethods = ['getEncryptionSpec', 'initializeEncryptionSpec'];
for (const methodName of encryptionSpecServiceStubMethods) {
const callPromise = this.encryptionSpecServiceStub.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.longrunning[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.encryptionSpecServiceStub;
}
/**
* 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();
}
getEncryptionSpec(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('getEncryptionSpec request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getEncryptionSpec response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getEncryptionSpec(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getEncryptionSpec 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;
});
}
initializeEncryptionSpec(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({
'encryption_spec.name': request.encryptionSpec.name ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('initializeEncryptionSpec response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('initializeEncryptionSpec request %j', request);
return this.innerApiCalls.initializeEncryptionSpec(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('initializeEncryptionSpec response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `initializeEncryptionSpec()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/encryption_spec_service.initialize_encryption_spec.js</caption>
* region_tag:dialogflow_v2beta1_generated_EncryptionSpecService_InitializeEncryptionSpec_async
*/
async checkInitializeEncryptionSpecProgress(name) {
this._log.info('initializeEncryptionSpec long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.initializeEncryptionSpec, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
/**
* 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);
}
/**
* Gets the latest state of a long-running operation. Clients can use this
* method to poll the operation result at intervals as recommended by the API
* service.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback
* The function which will be called with the result of the API call.
*
* The second parameter to the callback is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* const name = '';
* const [response] = await client.getOperation({name});
* // doThingsWith(response)
* ```
*/
getOperation(request, optionsOrCallback, callback) {
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 ?? '',
});
return this.operationsClient.getOperation(request, options, callback);
}
/**
* Lists operations that match the specified filter in the request. If the
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
*
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation collection.
* @param {string} request.filter - The standard list filter.
* @param {number=} request.pageSize -
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*
* @example
* ```
* const client = longrunning.operationsClient();
* for await (const response of client.listOperationsAsync(request));
* // doThingsWith(response)
* ```
*/
listOperationsAsync(request, options) {
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 ?? '',
});
return this.operationsClient.listOperationsAsync(request, options);
}
/**
* 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
* {@link 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 {@link Operation.error} value with a {@link google.rpc.Status.code} of
* 1, corresponding to `Code.CANCELLED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be cancelled.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {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: ''});
* ```
*/
cancelOperation(request, optionsOrCallback, callback) {
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 ?? '',
});
return this.operationsClient.cancelOperation(request, options, callback);
}
/**
* 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`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be deleted.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {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: ''});
* ```
*/
deleteOperation(request, optionsOrCallback, callback) {
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 ?? '',
});
return this.operationsClient.deleteOperation(request, options, callback);
}
// --------------------
// -- Path templates --
// --------------------
/**
* Return a fully-qualified encryptionSpec resource name string.
*
* @param {string} project
* @param {string} location
* @returns {string} Resource name string.
*/
encryptionSpecPath(project, location) {
return this.pathTemplates.encryptionSpecPathTemplate.render({
project: project,
location: location,
});
}
/**
* Parse the project from EncryptionSpec resource.
*
* @param {string} encryptionSpecName
* A fully-qualified path representing EncryptionSpec resource.
* @returns {string} A string representing the project.
*/
matchProjectFromEncryptionSpecName(encryptionSpecName) {
return this.pathTemplates.encryptionSpecPathTemplate.match(encryptionSpecName).project;
}
/**
* Parse the location from EncryptionSpec resource.
*
* @param {string} encryptionSpecName
* A fully-qualified path representing EncryptionSpec resource.
* @returns {string} A string representing the location.
*/
matchLocationFromEncryptionSpecName(encryptionSpecName) {
return this.pathTemplates.encryptionSpecPathTemplate.match(encryptionSpecName).location;
}
/**
* Return a fully-qualified generator resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} generator
* @returns {string} Resource name string.
*/
generatorPath(project, location, generator) {
return this.pathTemplates.generatorPathTemplate.render({
project: project,
location: location,
generator: generator,
});
}
/**
* Parse the project from Generator resource.
*
* @param {string} generatorName
* A fully-qualified path representing Generator resource.
* @returns {string} A string representing the project.
*/
matchProjectFromGeneratorName(generatorName) {
return this.pathTemplates.generatorPathTemplate.match(generatorName).project;
}
/**
* Parse the location from Generator resource.
*
* @param {string} generatorName
* A fully-qualified path representing Generator resource.
* @returns {string} A string representing the location.
*/
matchLocationFromGeneratorName(generatorName) {
return this.pathTemplates.generatorPathTemplate.match(generatorName).location;
}
/**
* Parse the generator from Generator resource.
*
* @param {string} generatorName
* A fully-qualified path representing Generator resource.
* @returns {string} A string representing the generator.
*/
matchGeneratorFromGeneratorName(generatorName) {
return this.pathTemplates.generatorPathTemplate.match(generatorName).generator;
}
/**
* Return a fully-qualified projectAgent resource name string.
*
* @param {string} project
* @returns {string} Resource name string.
*/
projectAgentPath(project) {
return this.pathTemplates.projectAgentPathTemplate.render({
project: project,
});
}
/**
* Parse the project from ProjectAgent resource.
*
* @param {string} projectAgentName
* A fully-qualified path representing project_agent resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectAgentName(projectAgentName) {
return this.pathTemplates.projectAgentPathTemplate.match(projectAgentName).project;
}
/**
* Return a fully-qualified projectAgentEntityType resource name string.
*
* @param {string} project
* @param {string} entity_type
* @returns {string} Resource name string.
*/
projectAgentEntityTypePath(project, entityType) {
return this.pathTemplates.projectAgentEntityTypePathTemplate.render({
project: project,
entity_type: entityType,
});
}
/**
* Parse the project from ProjectAgentEntityType resource.
*
* @param {string} projectAgentEntityTypeName
* A fully-qualified path representing project_agent_entity_type resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName) {
return this.pathTemplates.projectAgentEntityTypePathTemplate.match(projectAgentEntityTypeName).project;
}
/**
* Parse the entity_type from ProjectAgentEntityType resource.
*
* @param {string} projectAgentEntityTypeName
* A fully-qualified path representing project_agent_entity_type resource.
* @returns {string} A string representing the entity_type.
*/
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName) {
return this.pathTemplates.projectAgentEntityTypePathTemplate.match(projectAgentEntityTypeName).entity_type;
}
/**
* Return a fully-qualified projectAgentEnvironment resource name string.
*
* @param {string} project
* @param {string} environment
* @returns {string} Resource name string.
*/
projectAgentEnvironmentPath(project, environment) {
return this.pathTemplates.projectAgentEnvironmentPathTemplate.render({
project: project,
environment: environment,
});
}
/**
* Parse the project from ProjectAgentEnvironment resource.
*
* @param {string} projectAgentEnvironmentName
* A fully-qualified path representing project_agent_environment resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName) {
return this.pathTemplates.projectAgentEnvironmentPathTemplate.match(projectAgentEnvironmentName).project;
}
/**
* Parse the environment from ProjectAgentEnvironment resource.
*
* @param {string} projectAgentEnvironmentName
* A fully-qualified path representing project_agent_environment resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName) {
return this.pathTemplates.projectAgentEnvironmentPathTemplate.match(projectAgentEnvironmentName).environment;
}
/**
* Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.
*
* @param {string} project
* @param {string} environment
* @param {string} user
* @param {string} session
* @param {string} context
* @returns {string} Resource name string.
*/
projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context) {
return this.pathTemplates.projectAgentEnvironmentUserSessionContextPathTemplate.render({
project: project,
environment: environment,
user: user,
session: session,
context: context,
});
}
/**
* Parse the project from ProjectAgentEnvironmentUserSessionContext resource.
*
* @param {string} projectAgentEnvironmentUserSessionContextName
* A fully-qualified path representing project_agent_environment_user_session_context resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) {
return this.pathTemplates.projectAgentEnvironmentUserSessionContextPathTemplate.match(projectAgentEnvironmentUserSessionContextName).project;
}
/**
* Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.
*
* @param {string} projectAgentEnvironmentUserSessionContextName
* A fully-qualified path representing project_agent_environment_user_session_context resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) {
return this.pathTemplates.projectAgentEnvironmentUserSessionContextPathTemplate.match(projectAgentEnvironmentUserSessionContextName).environment;
}
/**
* Parse the user from ProjectAgentEnvironmentUserSessionContext resource.
*
* @param {string} projectAgentEnvironmentUserSessionContextName
* A fully-qualified path representing project_agent_environment_user_session_context resource.
* @returns {string} A string representing the user.
*/
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) {
return this.pathTemplates.projectAgentEnvironmentUserSessionContextPathTemplate.match(projectAgentEnvironmentUserSessionContextName).user;
}
/**
* Parse the session from ProjectAgentEnvironmentUserSessionContext resource.
*
* @param {string} projectAgentEnvironmentUserSessionContextName
* A fully-qualified path representing project_agent_environment_user_session_context resource.
* @returns {string} A string representing the session.
*/
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) {
return this.pathTemplates.projectAgentEnvironmentUserSessionContextPathTemplate.match(projectAgentEnvironmentUserSessionContextName).session;
}
/**
* Parse the context from ProjectAgentEnvironmentUserSessionContext resource.
*
* @param {string} projectAgentEnvironmentUserSessionContextName
* A fully-qualified path representing project_agent_environment_user_session_context resource.
* @returns {string} A string representing the context.
*/
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) {
return this.pathTemplates.projectAgentEnvironmentUserSessionContextPathTemplate.match(projectAgentEnvironmentUserSessionContextName).context;
}
/**
* Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.
*
* @param {string} project
* @param {string} environment
* @param {string} user
* @param {string} session
* @param {string} entity_type
* @returns {string} Resource name string.
*/
projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entityType) {
return this.pathTemplates.projectAgentEnvironmentUserSessionEntityTypePathTemplate.render({
project: project,
environment: environment,
user: user,
session: session,
entity_type: entityType,
});
}
/**
* Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.
*
* @param {string} projectAgentEnvironmentUserSessionEntityTypeName
* A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) {
return this.pathTemplates.projectAgentEnvironmentUserSessionEntityTypePathTemplate.match(projectAgentEnvironmentUserSessionEntityTypeName).project;
}
/**
* Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.
*
* @param {string} projectAgentEnvironmentUserSessionEntityTypeName
* A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) {
return this.pathTemplates.projectAgentEnvironmentUserSessionEntityTypePathTemplate.match(projectAgentEnvironmentUserSessionEntityTypeName).environment;
}
/**
* Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.
*
* @param {string} projectAgentEnvironmentUserSessionEntityTypeName
* A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
* @returns {string} A string representing the user.
*/
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) {
return this.pathTemplates.projectAgentEnvironme