Skip to content

Latest commit

 

History

History

README.md

Google Cloud Platform logo

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.

npm version

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

npm install @google-cloud/managedkafka

Samples

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

Sample Source Code
add acl entry source code
create acl source code
create cluster source code
create topic source code
delete acl source code
delete cluster source code
delete consumer group source code
delete topic source code
get acl source code
get cluster source code
get consumer group source code
get topic source code
list acls source code
list clusters source code
list consumer groups source code
list topics source code
remove acl entry source code
update acl source code
update cluster source code
update consumer group source code
update topic source code
create connect cluster source code
create connector source code
delete connect cluster source code
delete connector source code
get connect cluster source code
get connector source code
list connect clusters source code
list connectors source code
pause connector source code
restart connector source code
resume connector source code
stop connector source code
update connect cluster source code
update connector source code
cloud 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@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