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.
Managed Service for Apache Kafka API client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG.
- Managed Service for Apache Kafka API Nodejs Client API Reference
- Managed Service for Apache Kafka API Documentation
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 Managed Service for Apache Kafka API API.
- Set up authentication so you can access the API from your local workstation. ### Installing the client library
npm install @google-cloud/managedkafka-schemaregistry
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| check compatibility | source code |
| create schema registry | source code |
| create version | source code |
| delete schema config | source code |
| delete schema mode | source code |
| delete schema registry | source code |
| delete subject | source code |
| delete version | source code |
| get context | source code |
| get raw schema | source code |
| get raw schema version | source code |
| get schema | source code |
| get schema config | source code |
| get schema mode | source code |
| get schema registry | source code |
| get version | source code |
| list contexts | source code |
| list referenced schemas | source code |
| list schema registries | source code |
| list schema types | source code |
| list schema versions | source code |
| list subjects | source code |
| list subjects by schema id | source code |
| list versions | source code |
| lookup version | source code |
| update schema config | source code |
| update schema mode | source code |
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/managedkafka-schemaregistry@legacy-8 installs client libraries
for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template.
License
Apache Version 2.0
See LICENSE