Skip to content
Node.js client for Google Cloud Tasks: A fully managed service that allows you to manage the execution, dispatch and delivery of a large number of distributed tasks.
JavaScript TypeScript Python
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: update CONTRIBUTING.md and make releaseType node (#293) Oct 9, 2019
.kokoro build: update windows configuration to match new vm Jan 21, 2020
protos feat: move library to typescript code generation (#317) Jan 3, 2020
samples chore: release 1.7.1 (#333) Jan 9, 2020
src fix: proper routing headers Jan 9, 2020
system-test feat: move library to typescript code generation (#317) Jan 3, 2020
test feat: move library to typescript code generation (#317) Jan 3, 2020
.eslintignore feat: .d.ts for protos (#282) Sep 23, 2019
.eslintrc.yml Enable prefer-const in the eslint config (#82) Sep 20, 2018
.gitignore feat: move library to typescript code generation (#317) Jan 3, 2020
.jsdoc.js feat: move library to typescript code generation (#317) Jan 3, 2020
.nycrc chore: update .nycrc Jan 5, 2020
.prettierignore feat: generate the API (#1) Jun 13, 2018
.prettierrc feat: generate the API (#1) Jun 13, 2018
.repo-metadata.json fix(docs): move to new client docs URL (#244) Jun 13, 2019
CHANGELOG.md chore: release 1.7.1 (#333) Jan 9, 2020
CODE_OF_CONDUCT.md
CONTRIBUTING.md chore: update CONTRIBUTING.md and make releaseType node (#293) Oct 9, 2019
LICENSE chore: update license file (#135) Dec 4, 2018
README.md fix(docs): stop linking reference documents to anchor Aug 28, 2019
codecov.yaml Update kokoro config (#90) Oct 2, 2018
linkinator.config.json build: use config file for linkinator (#253) Jun 28, 2019
package.json chore: release 1.7.1 (#333) Jan 9, 2020
renovate.json fix(deps): pin TypeScript below 3.7.0 Dec 5, 2019
synth.metadata fix: proper routing headers Jan 9, 2020
synth.py feat: move library to typescript code generation (#317) Jan 3, 2020
tsconfig.json feat: move library to typescript code generation (#317) Jan 3, 2020
tslint.json feat: move library to typescript code generation (#317) Jan 3, 2020
webpack.config.js feat: move library to typescript code generation (#317) Jan 3, 2020

README.md

Google Cloud Platform logo

Cloud Tasks: Node.js Client

release level npm version codecov

Cloud Tasks API client for Node.js

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

  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

Using the client library

  // Imports the Google Cloud Tasks library.
  const {CloudTasksClient} = require('@google-cloud/tasks');

  // Instantiates a client.
  const client = new CloudTasksClient();

  // TODO(developer): Uncomment these lines and replace with your values.
  // const project = 'my-project-id';
  // const queue = 'my-appengine-queue';
  // const location = 'us-central1';
  // const payload = 'hello';

  // Construct the fully qualified queue name.
  const parent = client.queuePath(project, location, queue);

  const task = {
    appEngineHttpRequest: {
      httpMethod: 'POST',
      relativeUri: '/log_payload',
    },
  };

  if (payload) {
    task.appEngineHttpRequest.body = Buffer.from(payload).toString('base64');
  }

  if (inSeconds) {
    task.scheduleTime = {
      seconds: inSeconds + Date.now() / 1000,
    };
  }

  const request = {
    parent: parent,
    task: task,
  };

  console.log('Sending task:');
  console.log(task);
  // Send create task request.
  const [response] = await client.createTask(request);
  const name = response.name;
  console.log(`Created task ${name}`);

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Cloud Tasks Create HTTP Target source code Open in Cloud Shell
Cloud Tasks Create HTTP Target with Token source code Open in Cloud Shell
Create Queue source code Open in Cloud Shell
Cloud Tasks Create App Engine Target source code Open in Cloud Shell
Delete Queue source code Open in Cloud Shell
List Queues source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Server source code Open in Cloud Shell

The Cloud Tasks Node.js Client API Reference documentation also contains samples.

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is 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 GA libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE

You can’t perform that action at this time.