Datastream: Node.js Client

datastream 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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Datastream API.
Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/datastream

Using the client library

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent that owns the collection of connection profiles.
 */
// const parent = 'abc123'
/**
 *  Maximum number of connection profiles to return.
 *  If unspecified, at most 50 connection profiles will be returned.
 *  The maximum value is 1000; values above 1000 will be coerced to 1000.
 */
// const pageSize = 1234
/**
 *  Page token received from a previous `ListConnectionProfiles` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListConnectionProfiles`
 *  must match the call that provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Filter request.
 */
// const filter = 'abc123'
/**
 *  Order by fields for the result.
 */
// const orderBy = 'abc123'

// Imports the Datastream library
const {DatastreamClient} = require('@google-cloud/datastream').v1;

// Instantiates a client
const datastreamClient = new DatastreamClient();

async function listConnectionProfiles() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable =
    await datastreamClient.listConnectionProfilesAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

listConnectionProfiles();

Samples

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

Sample	Source Code	Try it
Datastream.create_connection_profile	source code
Datastream.create_private_connection	source code
Datastream.create_route	source code
Datastream.create_stream	source code
Datastream.delete_connection_profile	source code
Datastream.delete_private_connection	source code
Datastream.delete_route	source code
Datastream.delete_stream	source code
Datastream.discover_connection_profile	source code
Datastream.fetch_static_ips	source code
Datastream.get_connection_profile	source code
Datastream.get_private_connection	source code
Datastream.get_route	source code
Datastream.get_stream	source code
Datastream.get_stream_object	source code
Datastream.list_connection_profiles	source code
Datastream.list_private_connections	source code
Datastream.list_routes	source code
Datastream.list_stream_objects	source code
Datastream.list_streams	source code
Datastream.lookup_stream_object	source code
Datastream.run_stream	source code
Datastream.start_backfill_job	source code
Datastream.stop_backfill_job	source code
Datastream.update_connection_profile	source code
Datastream.update_stream	source code
Datastream.create_connection_profile	source code
Datastream.create_private_connection	source code
Datastream.create_route	source code
Datastream.create_stream	source code
Datastream.delete_connection_profile	source code
Datastream.delete_private_connection	source code
Datastream.delete_route	source code
Datastream.delete_stream	source code
Datastream.discover_connection_profile	source code
Datastream.fetch_errors	source code
Datastream.fetch_static_ips	source code
Datastream.get_connection_profile	source code
Datastream.get_private_connection	source code
Datastream.get_route	source code
Datastream.get_stream	source code
Datastream.list_connection_profiles	source code
Datastream.list_private_connections	source code
Datastream.list_routes	source code
Datastream.list_streams	source code
Datastream.update_connection_profile	source code
Datastream.update_stream	source code
Quickstart	source code

The Datastream 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/datastream@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 stable libraries 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