ContextQMD
Back to Google Cloud Node

[Managed Service for Apache Kafka API: Nodejs Client][homepage]

packages/google-cloud-managedkafka-schemaregistry/README.md

0.57.010.7 KB
Original Source

Managed Service for Apache Kafka API: Nodejs Client

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.

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 Managed Service for Apache Kafka API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

bash
npm install @google-cloud/managedkafka-schemaregistry

Samples

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

SampleSource Code
check compatibilitysource code
create schema registrysource code
create versionsource code
delete schema configsource code
delete schema modesource code
delete schema registrysource code
delete subjectsource code
delete versionsource code
get contextsource code
get raw schemasource code
get raw schema versionsource code
get schemasource code
get schema configsource code
get schema modesource code
get schema registrysource code
get versionsource code
list contextssource code
list referenced schemassource code
list schema registriessource code
list schema typessource code
list schema versionssource code
list subjectssource code
list subjects by schema idsource code
list versionssource code
lookup versionsource code
update schema configsource code
update schema modesource code
cloudsource 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