NetApp API: Node.js Client

release level npm version

NetApp 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

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

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.
 */
/**
 *  Required. Parent value
 */
// const parent = 'abc123'
/**
 *  The maximum number of items to return.
 */
// const pageSize = 1234
/**
 *  The next_page_token value to use if there are additional
 *  results to retrieve for this list request.
 */
// const pageToken = 'abc123'
/**
 *  Sort results. Supported values are "name", "name desc" or "" (unsorted).
 */
// const orderBy = 'abc123'
/**
 *  List filter.
 */
// const filter = 'abc123'

// Imports the Netapp library
const {NetAppClient} = require('@google-cloud/netapp').v1;

// Instantiates a client
const netappClient = new NetAppClient();

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

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

callListStoragePools();

Samples

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

SampleSource CodeTry it
Net_app.create_active_directorysource codeOpen in Cloud Shell
Net_app.create_backupsource codeOpen in Cloud Shell
Net_app.create_backup_policysource codeOpen in Cloud Shell
Net_app.create_backup_vaultsource codeOpen in Cloud Shell
Net_app.create_kms_configsource codeOpen in Cloud Shell
Net_app.create_replicationsource codeOpen in Cloud Shell
Net_app.create_snapshotsource codeOpen in Cloud Shell
Net_app.create_storage_poolsource codeOpen in Cloud Shell
Net_app.create_volumesource codeOpen in Cloud Shell
Net_app.delete_active_directorysource codeOpen in Cloud Shell
Net_app.delete_backupsource codeOpen in Cloud Shell
Net_app.delete_backup_policysource codeOpen in Cloud Shell
Net_app.delete_backup_vaultsource codeOpen in Cloud Shell
Net_app.delete_kms_configsource codeOpen in Cloud Shell
Net_app.delete_replicationsource codeOpen in Cloud Shell
Net_app.delete_snapshotsource codeOpen in Cloud Shell
Net_app.delete_storage_poolsource codeOpen in Cloud Shell
Net_app.delete_volumesource codeOpen in Cloud Shell
Net_app.encrypt_volumessource codeOpen in Cloud Shell
Net_app.get_active_directorysource codeOpen in Cloud Shell
Net_app.get_backupsource codeOpen in Cloud Shell
Net_app.get_backup_policysource codeOpen in Cloud Shell
Net_app.get_backup_vaultsource codeOpen in Cloud Shell
Net_app.get_kms_configsource codeOpen in Cloud Shell
Net_app.get_replicationsource codeOpen in Cloud Shell
Net_app.get_snapshotsource codeOpen in Cloud Shell
Net_app.get_storage_poolsource codeOpen in Cloud Shell
Net_app.get_volumesource codeOpen in Cloud Shell
Net_app.list_active_directoriessource codeOpen in Cloud Shell
Net_app.list_backup_policiessource codeOpen in Cloud Shell
Net_app.list_backup_vaultssource codeOpen in Cloud Shell
Net_app.list_backupssource codeOpen in Cloud Shell
Net_app.list_kms_configssource codeOpen in Cloud Shell
Net_app.list_replicationssource codeOpen in Cloud Shell
Net_app.list_snapshotssource codeOpen in Cloud Shell
Net_app.list_storage_poolssource codeOpen in Cloud Shell
Net_app.list_volumessource codeOpen in Cloud Shell
Net_app.resume_replicationsource codeOpen in Cloud Shell
Net_app.reverse_replication_directionsource codeOpen in Cloud Shell
Net_app.revert_volumesource codeOpen in Cloud Shell
Net_app.stop_replicationsource codeOpen in Cloud Shell
Net_app.update_active_directorysource codeOpen in Cloud Shell
Net_app.update_backupsource codeOpen in Cloud Shell
Net_app.update_backup_policysource codeOpen in Cloud Shell
Net_app.update_backup_vaultsource codeOpen in Cloud Shell
Net_app.update_kms_configsource codeOpen in Cloud Shell
Net_app.update_replicationsource codeOpen in Cloud Shell
Net_app.update_snapshotsource codeOpen in Cloud Shell
Net_app.update_storage_poolsource codeOpen in Cloud Shell
Net_app.update_volumesource codeOpen in Cloud Shell
Net_app.verify_kms_configsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The NetApp API 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/netapp@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