Batch API: Nodejs Client
This library is considered to be inpreview. This means it is still awork-in-progress and under active development. Any release is subject tobackwards-incompatible changes at any time.
Batch API client for Node.js
A comprehensive list of changes in each version may be found inthe CHANGELOG.
Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.
Table of contents:
Quickstart
Before you begin
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Batch API API.
- Set up authentication so you can access theAPI from your local workstation.### Installing the client library
npm install @google-cloud/batchSamples
Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| cancel job | source code |
| create job | source code |
| delete job | source code |
| get job | source code |
| get task | source code |
| list jobs | source code |
| list tasks | source code |
| cloud | source code |
| cancel job | source code |
| create job | source code |
| create resource allowance | source code |
| delete job | source code |
| delete resource allowance | source code |
| get job | source code |
| get resource allowance | source code |
| get task | source code |
| list jobs | source code |
| list resource allowances | source code |
| list tasks | source code |
| update job | source code |
| update resource allowance | source code |
| cloud | source code |
Supported Node.js Versions
Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/batch@legacy-8 installs client librariesfor versions compatible with Node.js 8.
Versioning
This library followsSemantic Versioning.
More Information:Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See theContributing Guide.
Please note that thisREADME.mdand a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template.
License
Apache Version 2.0
SeeLICENSE
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.