@google-cloud/tasks

What is @google-cloud/tasks?

@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.

What are @google-cloud/tasks's main functionalities?

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);

Other packages similar to @google-cloud/tasks

bull

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

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

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.

README

Cloud Tasks: Node.js Client

Cloud Tasks API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Cloud Tasks Node.js Client API Reference
• Cloud Tasks Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-tasks

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

• Quickstart

  • Before you begin
  • Installing the client library

• Samples

• Versioning

• Contributing

• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Cloud Tasks API.
4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/tasks

Samples

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.

Supported Node.js Versions

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:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

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.

Versioning

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

Contributing

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.

License

Apache Version 2.0

See LICENSE