Eventarc: Node.js Client
eventarc client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG .
- Eventarc Node.js Client API Reference
- Eventarc Documentation
- github.com/googleapis/google-cloud-node/packages/google-cloud-eventarc
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 Eventarc API .
- Set up authentication so you can access the API from your local workstation.
Installing the client library
npm install @google-cloud/eventarc
Using the client library
// Imports the Google Cloud client library
// remove this line after package is released
const {EventarcClient} = require(' @google-cloud/eventarc
');
// TODO: replace with your prefered project ID.
// const projectId = 'my-project'
// Creates a client
const client = new EventarcClient
();
async function doSomething() {
for await (const trigger of await client. listTriggersAsync
({
parent: client. locationPath
(projectId, 'us-central1'),
})) {
console.info(trigger.name);
}
}
doSomething();
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Eventarc.create_channel
|
source code | ![]() |
Eventarc.create_channel_connection
|
source code | ![]() |
Eventarc.create_enrollment
|
source code | ![]() |
Eventarc.create_google_api_source
|
source code | ![]() |
Eventarc.create_message_bus
|
source code | ![]() |
Eventarc.create_pipeline
|
source code | ![]() |
Eventarc.create_trigger
|
source code | ![]() |
Eventarc.delete_channel
|
source code | ![]() |
Eventarc.delete_channel_connection
|
source code | ![]() |
Eventarc.delete_enrollment
|
source code | ![]() |
Eventarc.delete_google_api_source
|
source code | ![]() |
Eventarc.delete_message_bus
|
source code | ![]() |
Eventarc.delete_pipeline
|
source code | ![]() |
Eventarc.delete_trigger
|
source code | ![]() |
Eventarc.get_channel
|
source code | ![]() |
Eventarc.get_channel_connection
|
source code | ![]() |
Eventarc.get_enrollment
|
source code | ![]() |
Eventarc.get_google_api_source
|
source code | ![]() |
Eventarc.get_google_channel_config
|
source code | ![]() |
Eventarc.get_message_bus
|
source code | ![]() |
Eventarc.get_pipeline
|
source code | ![]() |
Eventarc.get_provider
|
source code | ![]() |
Eventarc.get_trigger
|
source code | ![]() |
Eventarc.list_channel_connections
|
source code | ![]() |
Eventarc.list_channels
|
source code | ![]() |
Eventarc.list_enrollments
|
source code | ![]() |
Eventarc.list_google_api_sources
|
source code | ![]() |
Eventarc.list_message_bus_enrollments
|
source code | ![]() |
Eventarc.list_message_buses
|
source code | ![]() |
Eventarc.list_pipelines
|
source code | ![]() |
Eventarc.list_providers
|
source code | ![]() |
Eventarc.list_triggers
|
source code | ![]() |
Eventarc.update_channel
|
source code | ![]() |
Eventarc.update_enrollment
|
source code | ![]() |
Eventarc.update_google_api_source
|
source code | ![]() |
Eventarc.update_google_channel_config
|
source code | ![]() |
Eventarc.update_message_bus
|
source code | ![]() |
Eventarc.update_pipeline
|
source code | ![]() |
Eventarc.update_trigger
|
source code | ![]() |
Quickstart
|
source code | ![]() |
The Eventarc Node.js Client API Reference documentation also contains samples.
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/eventarc@legacy-8
installs client libraries
for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning .
This library is considered to be 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 stablelibraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide .
Please note that this README.md
, the samples/README.md
,
and a variety of configuration files in this repository (including .nycrc
and tsconfig.json
)
are generated from a central template. To edit one of these files, make an edit
to its templates in directory
.
License
Apache Version 2.0
See LICENSE