Cloud Tasks API client for Node.js
npm install @google-cloud/tasks[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "The comments you see below are used to generate those parts of the template in later states."
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

Cloud Tasks API client for Node.js
[//]: # "partials.introduction"
A comprehensive list of changes in each version may be found in
[the CHANGELOG][homepage_changelog].
* Cloud Tasks API Nodejs Client API Reference
Read more about the client libraries for Cloud APIs, including the older
Google APIs Client Libraries, in [Client Libraries Explained][explained].
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
Table of contents:
* Quickstart
* Before you begin
* Installing the client library
* Versioning
* Contributing
* License
1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Cloud Tasks API API][enable_api].
1. [Set up authentication][auth] so you can access the
API from your local workstation.
``bash`
npm install @google-cloud/tasks
[//]: # "partials.body"
Samples are in the [samples/][homepage_samples] directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
| --------------------------- | --------------------------------- |
| create queue | source code |
| create task | source code |
| delete queue | source code |
| delete task | source code |
| get iam policy | source code |
| get queue | source code |
| get task | source code |
| list queues | source code |
| list tasks | source code |
| pause queue | source code |
| purge queue | source code |
| resume queue | source code |
| run task | source code |
| set iam policy | source code |
| test iam permissions | source code |
| update queue | source code |
| cloud | source code |
| acknowledge task | source code |
| cancel lease | source code |
| create queue | source code |
| create task | source code |
| delete queue | source code |
| delete task | source code |
| get iam policy | source code |
| get queue | source code |
| get task | source code |
| lease tasks | source code |
| list queues | source code |
| list tasks | source code |
| pause queue | source code |
| purge queue | source code |
| renew lease | source code |
| resume queue | source code |
| run task | source code |
| set iam policy | source code |
| test iam permissions | source code |
| update queue | source code |
| upload queue yaml | source code |
| cloud | source code |
| create queue | source code |
| create task | source code |
| delete queue | source code |
| delete task | source code |
| get iam policy | source code |
| get queue | source code |
| get task | source code |
| list queues | source code |
| list tasks | source code |
| pause queue | source code |
| purge queue | source code |
| resume queue | source code |
| run task | source code |
| set iam policy | source code |
| test iam permissions | source code |
| update queue | source code |
| cloud | source code |
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).npm install @google-cloud/tasks@legacy-8
For example, installs client libraries
for versions compatible with Node.js 8.
This library follows Semantic Versioning.
More Information: [Google Cloud Platform Launch Stages][launch_stages]
[launch_stages]: https://cloud.google.com/terms/launch-stages
Contributions welcome! See the Contributing Guide.
Please note that this README.md.nycrc
and a variety of configuration files in this repository (including and tsconfig.json`)
are generated from a central template.
Apache Version 2.0
See LICENSE
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=cloudtasks.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-tasks/samples
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-tasks/CHANGELOG.md
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-tasks