# Storage Batch Operations 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.

[](https://www.npmjs.org/package/@google-cloud/storagebatchoperations)

Storage Batch Operations API client for Node.js

A comprehensive list of changes in each version may be found in
[the CHANGELOG](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/CHANGELOG.md).

- [Storage Batch Operations API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/storagebatchoperations/latest)
- [Storage Batch Operations API Documentation](https://cloud.google.com/storage/docs/batch-operations/overview)

Read more about the client libraries for Cloud APIs, including the older
Google APIs Client Libraries, in [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).

**Table of contents:**

- [Quickstart](https://docs.cloud.google.com/nodejs/docs/reference/storagebatchoperations/latest#quickstart)

  - [Before you begin](https://docs.cloud.google.com/nodejs/docs/reference/storagebatchoperations/latest#before-you-begin)
  - [Installing the client library](https://docs.cloud.google.com/nodejs/docs/reference/storagebatchoperations/latest#installing-the-client-library)
- [Versioning](https://docs.cloud.google.com/nodejs/docs/reference/storagebatchoperations/latest#versioning)

- [Contributing](https://docs.cloud.google.com/nodejs/docs/reference/storagebatchoperations/latest#contributing)
- [License](https://docs.cloud.google.com/nodejs/docs/reference/storagebatchoperations/latest#license)

## Quickstart

### Before you begin

1. [Select or create a Cloud Platform project](https://console.cloud.google.com/project).
2. [Enable billing for your project](https://support.google.com/cloud/answer/6293499#enable-billing).
3. [Enable the Storage Batch Operations API API](https://console.cloud.google.com/flows/enableapi?apiid=storagebatchoperations.googleapis.com).
4. [Set up authentication](https://cloud.google.com/docs/authentication/external/set-up-adc-local) so you can access the API from your local workstation. ### Installing the client library

    npm install @google-cloud/storagebatchoperations

## Samples

Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/samples) directory. Each sample's `README.md` has instructions for running its sample.

| Sample | Source Code |
|---|---|
| cancel job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/samples/generated/v1/storage_batch_operations.cancel_job.js) |
| create job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/samples/generated/v1/storage_batch_operations.create_job.js) |
| delete job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/samples/generated/v1/storage_batch_operations.delete_job.js) |
| get bucket operation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/samples/generated/v1/storage_batch_operations.get_bucket_operation.js) |
| get job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/samples/generated/v1/storage_batch_operations.get_job.js) |
| list bucket operations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/samples/generated/v1/storage_batch_operations.list_bucket_operations.js) |
| list jobs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-storagebatchoperations/samples/generated/v1/storage_batch_operations.list_jobs.js) |

## Supported Node.js Versions

Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#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](https://docs.npmjs.com/cli/dist-tag).
The dist-tags follow the naming convention `legacy-(version)`.
For example, `npm install @google-cloud/storagebatchoperations@legacy-8` installs client libraries
for versions compatible with Node.js 8.

## Versioning

This library follows [Semantic Versioning](http://semver.org/).

More Information: [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages)

## Contributing

Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).

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](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)