@google-cloud/tasks
Version:
Cloud Tasks API client for Node.js
1,033 lines • 63.9 kB
JavaScript
// 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. **
/* global window */
import * as gax from 'google-gax';
import path from 'path';
import { fileURLToPath } from 'url';
import { getJSON } from '../json-helper.cjs';
// @ts-ignore
const dirname = path.dirname(fileURLToPath(import.meta.url));
/**
* Client JSON configuration object, loaded from
* `src/v2/cloud_tasks_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = getJSON(path.join(dirname, 'cloud_tasks_client_config.json'));
const jsonProtos = getJSON(path.join(dirname, '..', '..', '..', 'protos/protos.json'));
import { loggingUtils as logging, decodeAnyProtosInArray } from 'google-gax';
const version = getJSON(path.join(dirname, '..', '..', '..', '..', 'package.json')).version;
/**
* Cloud Tasks allows developers to manage the execution of background
* work in their applications.
* @class
* @memberof v2
*/
export class CloudTasksClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = logging.log('tasks');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
locationsClient;
pathTemplates;
cloudTasksStub;
/**
* Construct an instance of CloudTasksClient.
*
* @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 | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* 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 CloudTasksClient({fallback: 'rest'}, 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 = 'cloudtasks.' + 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 = 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);
// Add ESM headers
const isEsm = true;
const isEsmString = isEsm ? '-esm' : '-cjs';
// 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}${isEsmString}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else if (opts.fallback === 'rest') {
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 = {
locationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}'),
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
queuePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/queues/{queue}'),
taskPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/queues/{queue}/tasks/{task}'),
};
// 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 = {
listQueues: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'queues'),
listTasks: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'tasks')
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.tasks.v2.CloudTasks', 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.cloudTasksStub) {
return this.cloudTasksStub;
}
// Put together the "service stub" for
// google.cloud.tasks.v2.CloudTasks.
this.cloudTasksStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.cloud.tasks.v2.CloudTasks') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.tasks.v2.CloudTasks, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const cloudTasksStubMethods = ['listQueues', 'getQueue', 'createQueue', 'updateQueue', 'deleteQueue', 'purgeQueue', 'pauseQueue', 'resumeQueue', 'getIamPolicy', 'setIamPolicy', 'testIamPermissions', 'listTasks', 'getTask', 'createTask', 'deleteTask', 'runTask'];
for (const methodName of cloudTasksStubMethods) {
const callPromise = this.cloudTasksStub.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.cloudTasksStub;
}
/**
* 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 'cloudtasks.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath,
* exists for compatibility reasons.
* @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 'cloudtasks.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'
];
}
/**
* 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();
}
getQueue(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('getQueue request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getQueue response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.getQueue(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getQueue 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
createQueue(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('createQueue request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('createQueue response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.createQueue(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('createQueue 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
updateQueue(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({
'queue.name': request.queue.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('updateQueue request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('updateQueue response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.updateQueue(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('updateQueue 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
deleteQueue(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('deleteQueue request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteQueue response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.deleteQueue(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteQueue 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
purgeQueue(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('purgeQueue request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('purgeQueue response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.purgeQueue(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('purgeQueue 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
pauseQueue(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('pauseQueue request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('pauseQueue response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.pauseQueue(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('pauseQueue 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
resumeQueue(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('resumeQueue request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('resumeQueue response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.resumeQueue(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('resumeQueue 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
getIamPolicy(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({
'resource': request.resource ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getIamPolicy request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getIamPolicy response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.getIamPolicy(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getIamPolicy 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
setIamPolicy(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({
'resource': request.resource ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('setIamPolicy request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('setIamPolicy response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.setIamPolicy(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('setIamPolicy 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
testIamPermissions(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({
'resource': request.resource ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('testIamPermissions request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('testIamPermissions response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.testIamPermissions(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('testIamPermissions 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
getTask(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('getTask request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getTask response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.getTask(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getTask 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
createTask(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('createTask request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('createTask response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.createTask(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('createTask 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
deleteTask(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('deleteTask request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteTask response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.deleteTask(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteTask 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
runTask(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('runTask request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('runTask response %j', response);
callback(error, response, options, rawResponse);
}
: undefined;
return this.innerApiCalls.runTask(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('runTask 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 = decodeAnyProtosInArray(error.statusDetails, protos);
}
throw error;
});
}
listQueues(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('listQueues values %j', values);
callback(error, values, nextPageRequest, rawResponse);
}
: undefined;
this._log.info('listQueues request %j', request);
return this.innerApiCalls
.listQueues(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listQueues values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listQueues`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The location name.
* For example: `projects/PROJECT_ID/locations/LOCATION_ID`
* @param {string} request.filter
* `filter` can be used to specify a subset of queues. Any
* {@link protos.google.cloud.tasks.v2.Queue|Queue} field can be used as a filter and
* several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
* filter syntax is the same as described in [Stackdriver's Advanced Logs
* Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
*
* Sample filter "state: PAUSED".
*
* Note that using filters might cause fewer queues than the
* requested page_size to be returned.
* @param {number} request.pageSize
* Requested page size.
*
* The maximum page size is 9800. If unspecified, the page size will
* be the maximum. Fewer queues than requested might be returned,
* even if more queues exist; use the
* {@link protos.google.cloud.tasks.v2.ListQueuesResponse.next_page_token|next_page_token}
* in the response to determine if more queues exist.
* @param {string} request.pageToken
* A token identifying the page of results to return.
*
* To request the first page results, page_token must be empty. To
* request the next page of results, page_token must be the value of
* {@link protos.google.cloud.tasks.v2.ListQueuesResponse.next_page_token|next_page_token}
* returned from the previous call to
* {@link protos.google.cloud.tasks.v2.CloudTasks.ListQueues|ListQueues} method. It is an
* error to switch the value of the
* {@link protos.google.cloud.tasks.v2.ListQueuesRequest.filter|filter} while iterating
* through pages.
* @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.tasks.v2.Queue|Queue} 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 `listQueuesAsync()`
* 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.
*/
listQueuesStream(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['listQueues'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listQueues stream %j', request);
return this.descriptors.page.listQueues.createStream(this.innerApiCalls.listQueues, request, callSettings);
}
/**
* Equivalent to `listQueues`, 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 location name.
* For example: `projects/PROJECT_ID/locations/LOCATION_ID`
* @param {string} request.filter
* `filter` can be used to specify a subset of queues. Any
* {@link protos.google.cloud.tasks.v2.Queue|Queue} field can be used as a filter and
* several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
* filter syntax is the same as described in [Stackdriver's Advanced Logs
* Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
*
* Sample filter "state: PAUSED".
*
* Note that using filters might cause fewer queues than the
* requested page_size to be returned.
* @param {number} request.pageSize
* Requested page size.
*
* The maximum page size is 9800. If unspecified, the page size will
* be the maximum. Fewer queues than requested might be returned,
* even if more queues exist; use the
* {@link protos.google.cloud.tasks.v2.ListQueuesResponse.next_page_token|next_page_token}
* in the response to determine if more queues exist.
* @param {string} request.pageToken
* A token identifying the page of results to return.
*
* To request the first page results, page_token must be empty. To
* request the next page of results, page_token must be the value of
* {@link protos.google.cloud.tasks.v2.ListQueuesResponse.next_page_token|next_page_token}
* returned from the previous call to
* {@link protos.google.cloud.tasks.v2.CloudTasks.ListQueues|ListQueues} method. It is an
* error to switch the value of the
* {@link protos.google.cloud.tasks.v2.ListQueuesRequest.filter|filter} while iterating
* through pages.
* @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.tasks.v2.Queue|Queue}. 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/v2/cloud_tasks.list_queues.js</caption>
* region_tag:cloudtasks_v2_generated_CloudTasks_ListQueues_async
*/
listQueuesAsync(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['listQueues'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listQueues iterate %j', request);
return this.descriptors.page.listQueues.asyncIterate(this.innerApiCalls['listQueues'], request, callSettings);
}
listTasks(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('listTasks values %j', values);
callback(error, values, nextPageRequest, rawResponse);
}
: undefined;
this._log.info('listTasks request %j', request);
return this.innerApiCalls
.listTasks(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listTasks values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listTasks`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The queue name. For example:
* `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
* @param {google.cloud.tasks.v2.Task.View} request.responseView
* The response_view specifies which subset of the
* {@link protos.google.cloud.tasks.v2.Task|Task} will be returned.
*
* By default response_view is {@link protos.google.cloud.tasks.v2.Task.View.BASIC|BASIC};
* not all information is retrieved by default because some data, such as
* payloads, might be desirable to return only when needed because
* of its large size or because of the sensitivity of data that it
* contains.
*
* Authorization for {@link protos.google.cloud.tasks.v2.Task.View.FULL|FULL} requires
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the {@link protos.google.cloud.tasks.v2.Task|Task} resource.
* @param {number} request.pageSize
* Maximum page size.
*
* Fewer tasks than requested might be returned, even if more tasks exist; use
* {@link protos.google.cloud.tasks.v2.ListTasksResponse.next_page_token|next_page_token}
* in the response to determine if more tasks exist.
*
* The maximum page size is 1000. If unspecified, the page size will be the
* maximum.
* @param {string} request.pageToken
* A token identifying the page of results to return.
*
* To request the first page results, page_token must be empty. To
* request the next page of results, page_token must be the value of
* {@link protos.google.cloud.tasks.v2.ListTasksResponse.next_page_token|next_page_token}
* returned from the previous call to
* {@link protos.google.cloud.tasks.v2.CloudTasks.ListTasks|ListTasks} method.
*
* The page token is valid for only 2 hours.
* @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.cl