Telco Automation API: Node.js Client

release level npm version

Telco Automation 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 Telco Automation API API.
  4. 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/telcoautomation

Samples

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

Sample Source Code Try it
Telco_automation.apply_deployment source code Open in Cloud Shell
Telco_automation.apply_hydrated_deployment source code Open in Cloud Shell
Telco_automation.approve_blueprint source code Open in Cloud Shell
Telco_automation.compute_deployment_status source code Open in Cloud Shell
Telco_automation.create_blueprint source code Open in Cloud Shell
Telco_automation.create_deployment source code Open in Cloud Shell
Telco_automation.create_edge_slm source code Open in Cloud Shell
Telco_automation.create_orchestration_cluster source code Open in Cloud Shell
Telco_automation.delete_blueprint source code Open in Cloud Shell
Telco_automation.delete_edge_slm source code Open in Cloud Shell
Telco_automation.delete_orchestration_cluster source code Open in Cloud Shell
Telco_automation.discard_blueprint_changes source code Open in Cloud Shell
Telco_automation.discard_deployment_changes source code Open in Cloud Shell
Telco_automation.get_blueprint source code Open in Cloud Shell
Telco_automation.get_deployment source code Open in Cloud Shell
Telco_automation.get_edge_slm source code Open in Cloud Shell
Telco_automation.get_hydrated_deployment source code Open in Cloud Shell
Telco_automation.get_orchestration_cluster source code Open in Cloud Shell
Telco_automation.get_public_blueprint source code Open in Cloud Shell
Telco_automation.list_blueprint_revisions source code Open in Cloud Shell
Telco_automation.list_blueprints source code Open in Cloud Shell
Telco_automation.list_deployment_revisions source code Open in Cloud Shell
Telco_automation.list_deployments source code Open in Cloud Shell
Telco_automation.list_edge_slms source code Open in Cloud Shell
Telco_automation.list_hydrated_deployments source code Open in Cloud Shell
Telco_automation.list_orchestration_clusters source code Open in Cloud Shell
Telco_automation.list_public_blueprints source code Open in Cloud Shell
Telco_automation.propose_blueprint source code Open in Cloud Shell
Telco_automation.reject_blueprint source code Open in Cloud Shell
Telco_automation.remove_deployment source code Open in Cloud Shell
Telco_automation.rollback_deployment source code Open in Cloud Shell
Telco_automation.search_blueprint_revisions source code Open in Cloud Shell
Telco_automation.search_deployment_revisions source code Open in Cloud Shell
Telco_automation.update_blueprint source code Open in Cloud Shell
Telco_automation.update_deployment source code Open in Cloud Shell
Telco_automation.update_hydrated_deployment source code Open in Cloud Shell
Telco_automation.apply_deployment source code Open in Cloud Shell
Telco_automation.apply_hydrated_deployment source code Open in Cloud Shell
Telco_automation.approve_blueprint source code Open in Cloud Shell
Telco_automation.compute_deployment_status source code Open in Cloud Shell
Telco_automation.create_blueprint source code Open in Cloud Shell
Telco_automation.create_deployment source code Open in Cloud Shell
Telco_automation.create_edge_slm source code Open in Cloud Shell
Telco_automation.create_orchestration_cluster source code Open in Cloud Shell
Telco_automation.delete_blueprint source code Open in Cloud Shell
Telco_automation.delete_edge_slm source code Open in Cloud Shell
Telco_automation.delete_orchestration_cluster source code Open in Cloud Shell
Telco_automation.discard_blueprint_changes source code Open in Cloud Shell
Telco_automation.discard_deployment_changes source code Open in Cloud Shell
Telco_automation.get_blueprint source code Open in Cloud Shell
Telco_automation.get_deployment source code Open in Cloud Shell
Telco_automation.get_edge_slm source code Open in Cloud Shell
Telco_automation.get_hydrated_deployment source code Open in Cloud Shell
Telco_automation.get_orchestration_cluster source code Open in Cloud Shell
Telco_automation.get_public_blueprint source code Open in Cloud Shell
Telco_automation.list_blueprint_revisions source code Open in Cloud Shell
Telco_automation.list_blueprints source code Open in Cloud Shell
Telco_automation.list_deployment_revisions source code Open in Cloud Shell
Telco_automation.list_deployments source code Open in Cloud Shell
Telco_automation.list_edge_slms source code Open in Cloud Shell
Telco_automation.list_hydrated_deployments source code Open in Cloud Shell
Telco_automation.list_orchestration_clusters source code Open in Cloud Shell
Telco_automation.list_public_blueprints source code Open in Cloud Shell
Telco_automation.propose_blueprint source code Open in Cloud Shell
Telco_automation.reject_blueprint source code Open in Cloud Shell
Telco_automation.remove_deployment source code Open in Cloud Shell
Telco_automation.rollback_deployment source code Open in Cloud Shell
Telco_automation.search_blueprint_revisions source code Open in Cloud Shell
Telco_automation.search_deployment_revisions source code Open in Cloud Shell
Telco_automation.update_blueprint source code Open in Cloud Shell
Telco_automation.update_deployment source code Open in Cloud Shell
Telco_automation.update_hydrated_deployment source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Telco Automation 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/telcoautomation@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

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