Distributed Cloud Edge Container API: Node.js Client

release levelnpm version

Distributed Cloud Edge Container API client for Node.js

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

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient 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 Container API API.
  4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/edgecontainer

Using the client library

/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** *  Required. The parent location, which owns this collection of clusters. */// const parent = 'abc123'/** *  The maximum number of resources to list. */// const pageSize = 1234/** *  A page token received from previous list request. *  A page token received from previous list request. */// const pageToken = 'abc123'/** *  Only resources matching this filter will be listed. */// const filter = 'abc123'/** *  Specifies the order in which resources will be listed. */// const orderBy = 'abc123'// Imports the Edgecontainer libraryconst {EdgeContainerClient} = require('@google-cloud/edgecontainer').v1;// Instantiates a clientconst edgecontainerClient = newEdgeContainerClient();async function callListClusters() {  // Construct request  const request = {    parent,  };  // Run request  const iterable = await edgecontainerClient.listClustersAsync(request);  for await (const response of iterable) {    console.log(response);  }}callListClusters();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource CodeTry it
Edge_container.create_clustersource codeOpen in Cloud Shell
Edge_container.create_node_poolsource codeOpen in Cloud Shell
Edge_container.create_vpn_connectionsource codeOpen in Cloud Shell
Edge_container.delete_clustersource codeOpen in Cloud Shell
Edge_container.delete_node_poolsource codeOpen in Cloud Shell
Edge_container.delete_vpn_connectionsource codeOpen in Cloud Shell
Edge_container.generate_access_tokensource codeOpen in Cloud Shell
Edge_container.generate_offline_credentialsource codeOpen in Cloud Shell
Edge_container.get_clustersource codeOpen in Cloud Shell
Edge_container.get_machinesource codeOpen in Cloud Shell
Edge_container.get_node_poolsource codeOpen in Cloud Shell
Edge_container.get_server_configsource codeOpen in Cloud Shell
Edge_container.get_vpn_connectionsource codeOpen in Cloud Shell
Edge_container.list_clusterssource codeOpen in Cloud Shell
Edge_container.list_machinessource codeOpen in Cloud Shell
Edge_container.list_node_poolssource codeOpen in Cloud Shell
Edge_container.list_vpn_connectionssource codeOpen in Cloud Shell
Edge_container.update_clustersource codeOpen in Cloud Shell
Edge_container.update_node_poolsource codeOpen in Cloud Shell
Edge_container.upgrade_clustersource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

TheDistributed Cloud Edge Container API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/edgecontainer@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.