Package Exports
- @google-cloud/batch
- @google-cloud/batch/build/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@google-cloud/batch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Batch API: Nodejs Client
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.
Batch 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 Batch API API.
- Set up authentication so you can access the API from your local workstation.
Installing the client library
npm install @google-cloud/batch
Samples
Samples are in the samples/
directory. Each sample's README.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 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.
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