Notebooks API: Nodejs Client

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

Notebooks API client for Node.js

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

Notebooks API Nodejs Client API Reference

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

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Notebooks API API.
Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/notebooks

Samples

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

Sample	Source Code
create runtime	source code
delete runtime	source code
diagnose runtime	source code
get runtime	source code
list runtimes	source code
refresh runtime token internal	source code
report runtime event	source code
reset runtime	source code
start runtime	source code
stop runtime	source code
switch runtime	source code
update runtime	source code
upgrade runtime	source code
create environment	source code
create execution	source code
create instance	source code
create schedule	source code
delete environment	source code
delete execution	source code
delete instance	source code
delete schedule	source code
diagnose instance	source code
get environment	source code
get execution	source code
get instance	source code
get instance health	source code
get schedule	source code
is instance upgradeable	source code
list environments	source code
list executions	source code
list instances	source code
list schedules	source code
register instance	source code
report instance info	source code
reset instance	source code
rollback instance	source code
set instance accelerator	source code
set instance labels	source code
set instance machine type	source code
start instance	source code
stop instance	source code
trigger schedule	source code
update instance config	source code
update instance metadata items	source code
update shielded instance config	source code
upgrade instance	source code
upgrade instance internal	source code
cloud	source code
create environment	source code
create instance	source code
delete environment	source code
delete instance	source code
get environment	source code
get instance	source code
is instance upgradeable	source code
list environments	source code
list instances	source code
register instance	source code
report instance info	source code
reset instance	source code
set instance accelerator	source code
set instance labels	source code
set instance machine type	source code
start instance	source code
stop instance	source code
upgrade instance	source code
upgrade instance internal	source code
cloud	source code
check instance upgradability	source code
create instance	source code
delete instance	source code
diagnose instance	source code
get instance	source code
list instances	source code
reset instance	source code
rollback instance	source code
start instance	source code
stop instance	source code
update instance	source code
upgrade instance	source code
cloud	source code

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

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