Package Exports
- @google-cloud/tasks
- @google-cloud/tasks/build/protos
Readme
Cloud Tasks API: Nodejs Client
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
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:
Quickstart
Before you begin
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Cloud Tasks API API.
- Set up authentication so you can access the API from your local workstation.
Installing the client library
npm install @google-cloud/tasksSamples
Samples are in the 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 |
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.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template.
License
Apache Version 2.0
See LICENSE