Network Connectivity Center: Node.js Client

Networkconnectivity 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 Network Connectivity Center API.
Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/network-connectivity

Using the client library

// Imports the Google Cloud client library

// eslint-disable-next-line node/no-missing-require
const {HubServiceClient} = require('@google-cloud/network-connectivity');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'
// const location = 'my-location'

// Creates a client
// eslint-disable-next-line no-unused-vars
const client = new HubServiceClient();

async function listNetworkHubs() {
  const [hubs] = await client.listHubs({
    parent: `projects/${projectId}/locations/${location}`,
  });
  console.info(hubs);
}
listNetworkHubs();

Samples

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

Sample	Source Code	Try it
Hub_service.accept_hub_spoke	source code
Hub_service.create_hub	source code
Hub_service.create_spoke	source code
Hub_service.delete_hub	source code
Hub_service.delete_spoke	source code
Hub_service.get_group	source code
Hub_service.get_hub	source code
Hub_service.get_route	source code
Hub_service.get_route_table	source code
Hub_service.get_spoke	source code
Hub_service.list_groups	source code
Hub_service.list_hub_spokes	source code
Hub_service.list_hubs	source code
Hub_service.list_route_tables	source code
Hub_service.list_routes	source code
Hub_service.list_spokes	source code
Hub_service.query_hub_status	source code
Hub_service.reject_hub_spoke	source code
Hub_service.update_group	source code
Hub_service.update_hub	source code
Hub_service.update_spoke	source code
Policy_based_routing_service.create_policy_based_route	source code
Policy_based_routing_service.delete_policy_based_route	source code
Policy_based_routing_service.get_policy_based_route	source code
Policy_based_routing_service.list_policy_based_routes	source code
Hub_service.create_hub	source code
Hub_service.create_spoke	source code
Hub_service.delete_hub	source code
Hub_service.delete_spoke	source code
Hub_service.get_hub	source code
Hub_service.get_spoke	source code
Hub_service.list_hubs	source code
Hub_service.list_spokes	source code
Hub_service.update_hub	source code
Hub_service.update_spoke	source code
Quickstart	source code

The Network Connectivity Center 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/network-connectivity@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