Skip to content

Latest commit

 

History

History

README.md

Google Cloud Platform logo

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

npm version

Distributed Cloud Edge Network 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 Distributed Cloud Edge Network API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/edgenetwork

Samples

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

Sample Source Code
create interconnect attachment source code
create network source code
create router source code
create subnet source code
delete interconnect attachment source code
delete network source code
delete router source code
delete subnet source code
diagnose interconnect source code
diagnose network source code
diagnose router source code
get interconnect source code
get interconnect attachment source code
get network source code
get router source code
get subnet source code
get zone source code
initialize zone source code
list interconnect attachments source code
list interconnects source code
list networks source code
list routers source code
list subnets source code
list zones source code
update router source code
update subnet 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/edgenetwork@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