@google-cloud/batch
TypeScript icon, indicating that this package has built-in type declarations

1.10.0 • Public • Published

Google Cloud Platform logo

release level npm version

Batch 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

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Batch 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/batch

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Parent path.
 */
// const parent = 'abc123'
/**
 *  List filter.
 */
// const filter = 'abc123'
/**
 *  Page size.
 */
// const pageSize = 1234
/**
 *  Page token.
 */
// const pageToken = 'abc123'

// Imports the Batch library
const {BatchServiceClient} = require('@google-cloud/batch').v1;

// Instantiates a client
const batchClient = new BatchServiceClient();

async function callListJobs() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = await batchClient.listJobsAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListJobs();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Batch_service.create_job source code Open in Cloud Shell
Batch_service.delete_job source code Open in Cloud Shell
Batch_service.get_job source code Open in Cloud Shell
Batch_service.get_task source code Open in Cloud Shell
Batch_service.list_jobs source code Open in Cloud Shell
Batch_service.list_tasks source code Open in Cloud Shell
Batch_service.create_job source code Open in Cloud Shell
Batch_service.create_resource_allowance source code Open in Cloud Shell
Batch_service.delete_job source code Open in Cloud Shell
Batch_service.delete_resource_allowance source code Open in Cloud Shell
Batch_service.get_job source code Open in Cloud Shell
Batch_service.get_resource_allowance source code Open in Cloud Shell
Batch_service.get_task source code Open in Cloud Shell
Batch_service.list_jobs source code Open in Cloud Shell
Batch_service.list_resource_allowances source code Open in Cloud Shell
Batch_service.list_tasks source code Open in Cloud Shell
Batch_service.update_job source code Open in Cloud Shell
Batch_service.update_resource_allowance source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Batch Node.js Client API Reference documentation also contains samples.

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.

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

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.

License

Apache Version 2.0

See LICENSE

Package Sidebar

Install

npm i @google-cloud/batch

Weekly Downloads

1,608

Version

1.10.0

License

Apache-2.0

Unpacked Size

5.03 MB

Total Files

29

Last publish

Collaborators

  • google-wombot
  • google-admin