Security News
JSR Working Group Kicks Off with Ambitious Roadmap and Plans for Open Governance
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
@google-cloud/tasks
Advanced tools
@google-cloud/tasks is a Node.js client library for Google Cloud Tasks, which allows you to manage the execution of large numbers of distributed requests. It provides a way to create, manage, and dispatch tasks to App Engine, HTTP, or Cloud Pub/Sub targets.
Create a Task
This feature allows you to create a new task in a specified queue. The task can be an HTTP request with a payload.
const {CloudTasksClient} = require('@google-cloud/tasks');
const client = new CloudTasksClient();
async function createTask() {
const project = 'my-project-id';
const queue = 'my-queue';
const location = 'us-central1';
const url = 'https://example.com/taskhandler';
const payload = 'Hello, World!';
const parent = client.queuePath(project, location, queue);
const task = {
httpRequest: {
httpMethod: 'POST',
url,
body: Buffer.from(payload).toString('base64'),
headers: {
'Content-Type': 'application/json',
},
},
};
const request = {parent, task};
const [response] = await client.createTask(request);
console.log(`Created task ${response.name}`);
}
createTask().catch(console.error);
Delete a Task
This feature allows you to delete a specified task from a queue.
const {CloudTasksClient} = require('@google-cloud/tasks');
const client = new CloudTasksClient();
async function deleteTask() {
const project = 'my-project-id';
const queue = 'my-queue';
const location = 'us-central1';
const task = 'my-task-id';
const name = client.taskPath(project, location, queue, task);
await client.deleteTask({name});
console.log(`Deleted task ${name}`);
}
deleteTask().catch(console.error);
List Tasks
This feature allows you to list all tasks in a specified queue.
const {CloudTasksClient} = require('@google-cloud/tasks');
const client = new CloudTasksClient();
async function listTasks() {
const project = 'my-project-id';
const queue = 'my-queue';
const location = 'us-central1';
const parent = client.queuePath(project, location, queue);
const [tasks] = await client.listTasks({parent});
tasks.forEach(task => {
console.log(`Task: ${task.name}`);
});
}
listTasks().catch(console.error);
Bull is a Node library that implements a fast and robust queue system based on Redis. It provides features like delayed jobs, rate-limited jobs, and job prioritization. Compared to @google-cloud/tasks, Bull is more focused on in-memory job queues and does not offer direct integration with Google Cloud services.
Agenda is a lightweight job scheduling library for Node.js that uses MongoDB as a persistence layer. It is designed for long-running jobs and provides features like job scheduling, job prioritization, and job concurrency. Unlike @google-cloud/tasks, Agenda is more suitable for applications that already use MongoDB and need a simple job scheduling solution.
Kue is a priority job queue backed by Redis, built for Node.js. It provides features like job events, job retries, and job progress tracking. Kue is similar to Bull but offers a different API and feature set. It does not provide the same level of integration with Google Cloud services as @google-cloud/tasks.
Cloud Tasks API client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG.
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
npm install @google-cloud/tasks
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Cloud_tasks.create_queue | source code | |
Cloud_tasks.create_task | source code | |
Cloud_tasks.delete_queue | source code | |
Cloud_tasks.delete_task | source code | |
Cloud_tasks.get_iam_policy | source code | |
Cloud_tasks.get_queue | source code | |
Cloud_tasks.get_task | source code | |
Cloud_tasks.list_queues | source code | |
Cloud_tasks.list_tasks | source code | |
Cloud_tasks.pause_queue | source code | |
Cloud_tasks.purge_queue | source code | |
Cloud_tasks.resume_queue | source code | |
Cloud_tasks.run_task | source code | |
Cloud_tasks.set_iam_policy | source code | |
Cloud_tasks.test_iam_permissions | source code | |
Cloud_tasks.update_queue | source code | |
Cloud_tasks.acknowledge_task | source code | |
Cloud_tasks.buffer_task | source code | |
Cloud_tasks.cancel_lease | source code | |
Cloud_tasks.create_queue | source code | |
Cloud_tasks.create_task | source code | |
Cloud_tasks.delete_queue | source code | |
Cloud_tasks.delete_task | source code | |
Cloud_tasks.get_iam_policy | source code | |
Cloud_tasks.get_queue | source code | |
Cloud_tasks.get_task | source code | |
Cloud_tasks.lease_tasks | source code | |
Cloud_tasks.list_queues | source code | |
Cloud_tasks.list_tasks | source code | |
Cloud_tasks.pause_queue | source code | |
Cloud_tasks.purge_queue | source code | |
Cloud_tasks.renew_lease | source code | |
Cloud_tasks.resume_queue | source code | |
Cloud_tasks.run_task | source code | |
Cloud_tasks.set_iam_policy | source code | |
Cloud_tasks.test_iam_permissions | source code | |
Cloud_tasks.update_queue | source code | |
Cloud_tasks.upload_queue_yaml | source code | |
Cloud_tasks.buffer_task | source code | |
Cloud_tasks.create_queue | source code | |
Cloud_tasks.create_task | source code | |
Cloud_tasks.delete_queue | source code | |
Cloud_tasks.delete_task | source code | |
Cloud_tasks.get_iam_policy | source code | |
Cloud_tasks.get_queue | source code | |
Cloud_tasks.get_task | source code | |
Cloud_tasks.list_queues | source code | |
Cloud_tasks.list_tasks | source code | |
Cloud_tasks.pause_queue | source code | |
Cloud_tasks.purge_queue | source code | |
Cloud_tasks.resume_queue | source code | |
Cloud_tasks.run_task | source code | |
Cloud_tasks.set_iam_policy | source code | |
Cloud_tasks.test_iam_permissions | source code | |
Cloud_tasks.update_queue | source code | |
Quickstart | source code |
The Cloud Tasks Node.js Client API Reference documentation also contains samples.
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm dist-tags.
The dist-tags follow the naming convention legacy-(version)
.
For example, npm install @google-cloud/tasks@legacy-8
installs client libraries
for versions compatible with Node.js 8.
This library follows Semantic Versioning.
This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stages
Contributions welcome! See the Contributing Guide.
Please note that this README.md
, the samples/README.md
,
and a variety of configuration files in this repository (including .nycrc
and tsconfig.json
)
are generated from a central template. To edit one of these files, make an edit
to its templates in
directory.
Apache Version 2.0
See LICENSE
FAQs
Cloud Tasks API client for Node.js
The npm package @google-cloud/tasks receives a total of 225,673 weekly downloads. As such, @google-cloud/tasks popularity was classified as popular.
We found that @google-cloud/tasks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.