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/batch@legacy-8 installs client libraries
for versions compatible with Node.js 8.
This library is considered to be in preview. This means it is still a
work-in-progress and under active development. Any release is subject to
backwards-incompatible changes at any time.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["Version latestkeyboard_arrow_down\n\n- [1.16.0 (latest)](/nodejs/docs/reference/batch/latest)\n- [1.15.0](/nodejs/docs/reference/batch/1.15.0)\n- [1.12.0](/nodejs/docs/reference/batch/1.12.0)\n- [1.11.0](/nodejs/docs/reference/batch/1.11.0)\n- [1.8.0](/nodejs/docs/reference/batch/1.8.0)\n- [1.7.0](/nodejs/docs/reference/batch/1.7.0)\n- [1.5.0](/nodejs/docs/reference/batch/1.5.0)\n- [1.4.0](/nodejs/docs/reference/batch/1.4.0)\n- [1.3.0](/nodejs/docs/reference/batch/1.3.0)\n- [1.1.0](/nodejs/docs/reference/batch/1.1.0)\n- [0.7.1](/nodejs/docs/reference/batch/0.7.1)\n- [0.6.1](/nodejs/docs/reference/batch/0.6.1)\n- [0.5.0](/nodejs/docs/reference/batch/0.5.0)\n- [0.3.2](/nodejs/docs/reference/batch/0.3.2) \n\n[Batch: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-batch)\n==============================================================================================================\n\n[](https://cloud.google.com/terms/launch-stages)\n[](https://www.npmjs.org/package/@google-cloud/batch)\n\nBatch client for Node.js\n\nA comprehensive list of changes in each version may be found in\n[the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-batch/CHANGELOG.md).\n\n- [Batch Node.js Client API Reference](https://cloud.google.com/nodejs/docs/reference/batch/latest)\n- [Batch Documentation](https://cloud.google.com/batch/docs)\n- [github.com/googleapis/google-cloud-node/packages/google-cloud-batch](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-batch)\n\nRead more about the client libraries for Cloud APIs, including the older\nGoogle APIs Client Libraries, in [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).\n\n**Table of contents:**\n\n- [Quickstart](#quickstart)\n - [Before you begin](#before-you-begin)\n - [Installing the client library](#installing-the-client-library)\n - [Using the client library](#using-the-client-library)\n- [Samples](#samples)\n- [Versioning](#versioning)\n- [Contributing](#contributing)\n- [License](#license)\n\nQuickstart\n----------\n\n### Before you begin\n\n1. [Select or create a Cloud Platform project](https://console.cloud.google.com/project).\n2. [Enable billing for your project](https://support.google.com/cloud/answer/6293499#enable-billing).\n3. [Enable the Batch API](https://console.cloud.google.com/flows/enableapi?apiid=batch.googleapis.com).\n4. [Set up authentication](https://cloud.google.com/docs/authentication/external/set-up-adc-local) so you can access the API from your local workstation.\n\n### Installing the client library\n\n npm install @google-cloud/batch\n\n### Using the client library\n\n /**\n * This snippet has been automatically generated and should be regarded as a code template only.\n * It will require modifications to work.\n * It may require correct/in-range values for request initialization.\n * TODO(developer): Uncomment these variables before running the sample.\n */\n /**\n * Parent path.\n */\n // const parent = 'abc123'\n /**\n * List filter.\n */\n // const filter = 'abc123'\n /**\n * Page size.\n */\n // const pageSize = 1234\n /**\n * Page token.\n */\n // const pageToken = 'abc123'\n\n // Imports the Batch library\n const {BatchServiceClient} = require('https://cloud.google.com/nodejs/docs/reference/batch/latest/overview.html').v1;\n\n // Instantiates a client\n const batchClient = new https://cloud.google.com/nodejs/docs/reference/batch/latest/overview.html();\n\n async function callListJobs() {\n // Construct request\n const request = {\n parent,\n };\n\n // Run request\n const iterable = await batchClient.listJobsAsync(request);\n for await (const response of iterable) {\n console.log(response);\n }\n }\n\n callListJobs();\n\nSamples\n-------\n\nSamples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-batch/samples) directory. Each sample's `README.md` has instructions for running its sample.\n\nThe [Batch Node.js Client API Reference](https://cloud.google.com/nodejs/docs/reference/batch/latest) documentation\nalso contains samples.\n\nSupported Node.js Versions\n--------------------------\n\nOur client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).\nLibraries are compatible with all current *active* and *maintenance* versions of\nNode.js.\nIf you are using an end-of-life version of Node.js, we recommend that you update\nas soon as possible to an actively supported LTS version.\n\nGoogle's client libraries support legacy versions of Node.js runtimes on a\nbest-efforts basis with the following warnings:\n\n- Legacy versions are not tested in continuous integration.\n- Some security patches and features cannot be backported.\n- Dependencies cannot be kept up-to-date.\n\nClient libraries targeting some end-of-life versions of Node.js are available, and\ncan be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).\nThe dist-tags follow the naming convention `legacy-(version)`.\nFor example, `npm install @google-cloud/batch@legacy-8` installs client libraries\nfor versions compatible with Node.js 8.\n\nVersioning\n----------\n\nThis library follows [Semantic Versioning](http://semver.org/).\n\nThis library is considered to be in **preview**. This means it is still a\nwork-in-progress and under active development. Any release is subject to\nbackwards-incompatible changes at any time.\n\nMore Information: [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages)\n\nContributing\n------------\n\nContributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).\n\nPlease note that this `README.md`, the `samples/README.md`,\nand a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)\nare generated from a central template. To edit one of these files, make an edit\nto its templates in\n[directory](https://github.com/googleapis/synthtool).\n\nLicense\n-------\n\nApache Version 2.0\n\nSee [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)"]]