NetApp API: Node.js Client

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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the NetApp API API.
Set up authentication 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.

Sample	Source Code	Try it
Net_app.create_active_directory	source code
Net_app.create_backup	source code
Net_app.create_backup_policy	source code
Net_app.create_backup_vault	source code
Net_app.create_kms_config	source code
Net_app.create_replication	source code
Net_app.create_snapshot	source code
Net_app.create_storage_pool	source code
Net_app.create_volume	source code
Net_app.delete_active_directory	source code
Net_app.delete_backup	source code
Net_app.delete_backup_policy	source code
Net_app.delete_backup_vault	source code
Net_app.delete_kms_config	source code
Net_app.delete_replication	source code
Net_app.delete_snapshot	source code
Net_app.delete_storage_pool	source code
Net_app.delete_volume	source code
Net_app.encrypt_volumes	source code
Net_app.get_active_directory	source code
Net_app.get_backup	source code
Net_app.get_backup_policy	source code
Net_app.get_backup_vault	source code
Net_app.get_kms_config	source code
Net_app.get_replication	source code
Net_app.get_snapshot	source code
Net_app.get_storage_pool	source code
Net_app.get_volume	source code
Net_app.list_active_directories	source code
Net_app.list_backup_policies	source code
Net_app.list_backup_vaults	source code
Net_app.list_backups	source code
Net_app.list_kms_configs	source code
Net_app.list_replications	source code
Net_app.list_snapshots	source code
Net_app.list_storage_pools	source code
Net_app.list_volumes	source code
Net_app.resume_replication	source code
Net_app.reverse_replication_direction	source code
Net_app.revert_volume	source code
Net_app.stop_replication	source code
Net_app.switch_active_replica_zone	source code
Net_app.update_active_directory	source code
Net_app.update_backup	source code
Net_app.update_backup_policy	source code
Net_app.update_backup_vault	source code
Net_app.update_kms_config	source code
Net_app.update_replication	source code
Net_app.update_snapshot	source code
Net_app.update_storage_pool	source code
Net_app.update_volume	source code
Net_app.verify_kms_config	source code
Quickstart	source code

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 stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

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