Back to Google Cloud Node

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

packages/google-cloud-managedkafka/README.md

0.57.011.3 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

Samples

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

SampleSource Code
add acl entrysource code
create aclsource code
create clustersource code
create topicsource code
delete aclsource code
delete clustersource code
delete consumer groupsource code
delete topicsource code
get aclsource code
get clustersource code
get consumer groupsource code
get topicsource code
list aclssource code
list clusterssource code
list consumer groupssource code
list topicssource code
remove acl entrysource code
update aclsource code
update clustersource code
update consumer groupsource code
update topicsource code
create connect clustersource code
create connectorsource code
delete connect clustersource code
delete connectorsource code
get connect clustersource code
get connectorsource code
list connect clusterssource code
list connectorssource code
pause connectorsource code
restart connectorsource code
resume connectorsource code
stop connectorsource code
update connect clustersource code
update connectorsource 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@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