Service Directory: Node.js Client
Servicedirectory 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
- Select or create a Cloud Platform project .
- Enable billing for your project .
- Enable the Service Directory API .
- 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/service-directory
Using the client library
//
// TODO(developer): Uncomment these variables before running the sample.
//
// const projectId = 'my-project';
// const locationId = 'us-central1';
// Imports the Google Cloud client library
const {
RegistrationServiceClient,
} = require(' @google-cloud/service-directory
');
// Creates a client
const registrationServiceClient = new RegistrationServiceClient
();
// Build the location name
const locationName = registrationServiceClient.locationPath(
projectId,
locationId
);
async function listNamespaces() {
const [namespaces] = await registrationServiceClient.listNamespaces({
parent: locationName,
});
console.log('Namespaces: ');
for (const n of namespaces) {
console.log(`${n.name}`);
}
return namespaces;
}
return listNamespaces();
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Create Endpoint
|
source code | ![]() |
Create Namespace
|
source code | ![]() |
Create Service
|
source code | ![]() |
Delete Endpoint
|
source code | ![]() |
Delete Namespace
|
source code | ![]() |
Delete Service
|
source code | ![]() |
Quickstart
|
source code | ![]() |
Resolve Service
|
source code | ![]() |
The Service Directory 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/service-directory@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 stablelibraries 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