@google-cloud/notebooks

AI Platform Notebooks: Node.js Client

Notebooks client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

• AI Platform Notebooks Node.js Client API Reference
• AI Platform Notebooks Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-notebooks

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

• Select or create a Cloud Platform project.
• Enable billing for your project.
• Enable the AI Platform Notebooks API.
• 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/notebooks

Using the client library

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = 'my-project';
// const location = 'global';

// Imports the Google Cloud Some API library
const {NotebookServiceClient} = require('@google-cloud/notebooks');
const client = new NotebookServiceClient();
async function listInstances() {
  const [instances] = await client.listInstances({
    parent: `projects/${projectId}/locations/${location}`,
  });
  for (const instance of instances) {
    console.info(`instance: ${instance.name}`);
  }
}
listInstances();

Samples

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

Sample	Source Code	Try it
Managed_notebook_service.create_runtime	source code
Managed_notebook_service.delete_runtime	source code
Managed_notebook_service.diagnose_runtime	source code
Managed_notebook_service.get_runtime	source code
Managed_notebook_service.list_runtimes	source code
Managed_notebook_service.refresh_runtime_token_internal	source code
Managed_notebook_service.report_runtime_event	source code
Managed_notebook_service.reset_runtime	source code
Managed_notebook_service.start_runtime	source code
Managed_notebook_service.stop_runtime	source code
Managed_notebook_service.switch_runtime	source code
Managed_notebook_service.update_runtime	source code
Managed_notebook_service.upgrade_runtime	source code
Notebook_service.create_environment	source code
Notebook_service.create_execution	source code
Notebook_service.create_instance	source code
Notebook_service.create_schedule	source code
Notebook_service.delete_environment	source code
Notebook_service.delete_execution	source code
Notebook_service.delete_instance	source code
Notebook_service.delete_schedule	source code
Notebook_service.diagnose_instance	source code
Notebook_service.get_environment	source code
Notebook_service.get_execution	source code
Notebook_service.get_instance	source code
Notebook_service.get_instance_health	source code
Notebook_service.get_schedule	source code
Notebook_service.is_instance_upgradeable	source code
Notebook_service.list_environments	source code
Notebook_service.list_executions	source code
Notebook_service.list_instances	source code
Notebook_service.list_schedules	source code
Notebook_service.register_instance	source code
Notebook_service.report_instance_info	source code
Notebook_service.reset_instance	source code
Notebook_service.rollback_instance	source code
Notebook_service.set_instance_accelerator	source code
Notebook_service.set_instance_labels	source code
Notebook_service.set_instance_machine_type	source code
Notebook_service.start_instance	source code
Notebook_service.stop_instance	source code
Notebook_service.trigger_schedule	source code
Notebook_service.update_instance_config	source code
Notebook_service.update_instance_metadata_items	source code
Notebook_service.update_shielded_instance_config	source code
Notebook_service.upgrade_instance	source code
Notebook_service.upgrade_instance_internal	source code
Notebook_service.create_environment	source code
Notebook_service.create_instance	source code
Notebook_service.delete_environment	source code
Notebook_service.delete_instance	source code
Notebook_service.get_environment	source code
Notebook_service.get_instance	source code
Notebook_service.is_instance_upgradeable	source code
Notebook_service.list_environments	source code
Notebook_service.list_instances	source code
Notebook_service.register_instance	source code
Notebook_service.report_instance_info	source code
Notebook_service.reset_instance	source code
Notebook_service.set_instance_accelerator	source code
Notebook_service.set_instance_labels	source code
Notebook_service.set_instance_machine_type	source code
Notebook_service.start_instance	source code
Notebook_service.stop_instance	source code
Notebook_service.upgrade_instance	source code
Notebook_service.upgrade_instance_internal	source code
Notebook_service.check_instance_upgradability	source code
Notebook_service.create_instance	source code
Notebook_service.delete_instance	source code
Notebook_service.diagnose_instance	source code
Notebook_service.get_instance	source code
Notebook_service.list_instances	source code
Notebook_service.reset_instance	source code
Notebook_service.rollback_instance	source code
Notebook_service.start_instance	source code
Notebook_service.stop_instance	source code
Notebook_service.update_instance	source code
Notebook_service.upgrade_instance	source code
Quickstart	source code

The AI Platform Notebooks 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/notebooks@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