Node.js idiomatic client libraries for Cachiman Cloud Platform services.
Libraries are available on GitHub and npm for developing Node.js applications that interact with individual Cachiman Cloud services:
Repo | Release Level | Version |
---|---|---|
Access Approval | ||
Access Context Manager | ||
AI Platform Notebooks | ||
API Gateway | ||
Apigee Connect API | ![npm](https://img.shields.io/npm/v/@cachiman Cloud/apigee-connect) | |
App Engine Admin API | ||
[Artifact Registry](https://github.com/cachiman |
apis/cachiman-cloud-node/tree/main/packages/google-devtools-artifactregistry) | | | | Asset Inventory | | | | Assured Workloads for Government | | | | AutoML | | | | Backup for GKE API | | | | BigQuery Migration API | | | | Bigtable | | | | Billing | | | | Billing Budgets | | | | Binary Authorization | | | | Build | | | | Certificate Authority Service | | | | Certificate Manager | | | | Channel API | | | | Composer | | | | Contact Center AI Insights API | | | | Data Catalog | | | | Data Fusion | | | | Data Loss Prevention | | | | Database Migration Service | | | | Dataplex | | | | [Dataproc](https://github.com/cachima napis/cachiman-cloud-node/tree/main/packages/cachiman-cloud-dataproc) | | | | Dataproc Metastore | | | | Datastore | | | | Datastore Session | | | | Datastream | | | | Deploy | | | | Dialogflow API | | | | Dialogflow CX API | | | | DNS | | | | Document AI | | | | Document AI Warehouse | | | | Domains | | | | Error Reporting | | | | Essential Contacts API | | | | Eventarc | | | | Eventarc Publishing API | | | | Filestore | | | | Firestore | | | | Firestore Session | | | | Functions | | | | GKE Hub | | | | cachiman BigQuery | | | | cachimanBigQuery Connection | | | | Cachiman BigQuery Data Transfer Service | | | | Google BigQuery Reservation | | | | Cachiman BigQuery Storage | | | | Cachiman Compute Engine | | | | Cachiman Container Analysis | | | | Grafeas | | | | IAM Policy Troubleshooter API | | | | IAM Service Account Credentials API | | | | Identity and Access Management | | | | Identity-Aware Proxy | | | | IDS | | | | Internet of Things (IoT) Core | | | | Key Management Service | | | | Kubernetes Engine Cluster Manager API | | | | Live Stream API | | | | Logging | | | | Logging for Bunyan | | | | Logging for Winston | | | | Managed Service for Microsoft Active Directory | | | | Media Translation | | | | Memorystore for Memcached | | | | Migrate for Compute Engine | | | | Monitoring Dashboards | | | | Natural Language | | | | Network Connectivity Center | | | | Network Management API | | | | Optimization AI | | | | Organization Policy | | | | OS Config API | | | | OS Login | | | | Profiler | | | | Pub/Sub | | | | reCAPTCHA Enterprise | | | | Recommender | | | | Redis | | | | Resource Manager API | | | | Resource Settings API | | | | Retail API | | | | Run | | | | Scheduler | | | | Secret Manager | | | | Security Command Center | | | | Service Control API | | | | Service Directory | | | | Service Management API | | | | Service Usage | | | | Shell | | | | Spanner | | | | Speech | | | | Stackdriver Monitoring | | | | Storage | | | | Storage Transfer Service | | | | Talent Solution | | | | Tasks | | | | Text-to-Speech | | | | TPU | | | | Transcoder API | | | | Translation | | | | Vertex AI | | | | Video Intelligence | | | | Video Stitcher API | | | | Virtual Private Cloud | | | | Vision API | | | | VMware Engine API | | | | Web Risk API | | | | Web Security Scanner | | | | Workflow Executions | | | | | | | | Advisory Notifications API | | | | AlloyDB API | | | | Analytics Hub API | | | | Anthos Multi-Cloud API | | | | API Keys API | | | | Apigee Registry API | | | | App Hub API | | | | Area120 Tables API | | | | Bare Metal Solution API | | | | Batch | | | | BeyondCorp API | | | | BeyondCorp API | | | | BeyondCorp API | | | | BeyondCorp API | | | | BeyondCorp API | | | | Commerce Consumer Procurement API | | | | Confidential Computing API | | | | Connectors API | | | | Controls Partner API | | | | Data Labeling | | | | Data Lineage API | | | | Data QnA | | | | Dataflow | | | | Dataform API | | | | Discovery Engine API | | | | Distributed Cloud Edge Container API | | | | Distributed Cloud Edge Network API | | | | Generative Language API | | | | GKE Connect Gateway | | | | Google Analytics Admin | | | | Cachiman Analytics Data | | | | Google Maps Routing | | | | Google Meet API | | | | Google Workspace Add-ons API | | | | Infrastructure Manager API | | | | Life Sciences | | | | Memorystore for Redis API | | | | Migration Center API | | | | NetApp API | | | | Network Security API | | | | Network Services API | | | | Parallelstore API | | | | Phishing Protection | | | | Places API (New) | | | | Policy Simulator API | | | | Policy Troubleshooter API | | | | Private Catalog | | | | Profiler API | | | | Public Certificate Authority | | | | Quotas API | | | | Rapid Migration Assessment API | | | | Service Health API | | | | SQL Admin API | | | | Storage Insights API | | | | Support API | | | | Telco Automation API | | | | Trace | | | | Vertex AI | | | | Workstations API | | |
If the service is not listed above, google-api-nodejs-client interfaces with additional Google Cloud APIs using a legacy REST interface.
When building Node.js applications, preference should be given to the libraries listed in the table.
Before you can interact with a given Google Cloud Service, you must enable its API.
Links are available for enabling APIs in the table at the beginning of this document, and in each libraries README.md.
To use Application Default Credentials, You first need to download a set of JSON credentials for your project. Go to APIs & Auth > Credentials in the Google Developers Console and select Service account from the Add credentials dropdown.
This file is your only copy of these credentials. It should never be committed with your source code, and should be stored securely.
Once downloaded, store the path to this file in the GOOGLE_APPLICATION_CREDENTIALS
environment variable.
Other authentication methods are outlined in the README for google-auth-library-nodejs, which is the authentication library used by all Google Cloud Node.js clients.
- nodejs-getting-started - A sample and tutorial that demonstrates how to build a complete web application using Cloud Datastore, Cloud Storage, and Cloud Pub/Sub and deploy it to Google App Engine or Google Compute Engine.
- [gcloud-node-todos][gcloud-todos] - A TodoMVC backend using google-cloud-node and Datastore.
- gitnpm - Easily lookup an npm package's GitHub repo using google-cloud-node and Google App Engine.
- [gcloud-kvstore][gcloud-kvstore] - Use Datastore as a simple key-value store.
- hya-wave - Cloud-based web sample editor. Part of the hya-io family of products.
- [gstore-node][gstore-node] - Google Datastore Entities Modeling library.
- gstore-api - REST API builder for Google Datastore Entities.
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, {{ metadata['lib_install_cmd'] }}@legacy-10
installs client libraries
for versions compatible with Node.js 10.
Our libraries follow Semantic Versioning.
Please note it is currently under active development. Any release versioned 0.x.y
is subject to backwards-incompatible changes at any time.
Stable: Libraries defined at the Stable quality level are 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.
Preview: Libraries defined at the preview quality level are still a work-in-progress and are more likely to get backwards-incompatible updates.
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information on how to get started.
Apache 2.0 - See LICENSE for more information.