Nightly Panic Munchies

    @google-cloud/datastream
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    Google Cloud Platform logo

    Datastream: Node.js Client

    release level npm version

    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

    Before you begin

    1. Select or create a Cloud Platform project.
    2. Enable billing for your project.
    3. Enable the Datastream API.
    4. Set up authentication with a service account 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
    Quickstart source code Open in Cloud Shell

    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

    Install

    npm i @google-cloud/datastream

    DownloadsWeekly Downloads

    3

    Version

    1.1.0

    License

    Apache-2.0

    Unpacked Size

    5.1 MB

    Total Files

    28

    Last publish

    Collaborators

    • ofrobots
    • google-wombot
    • google-admin
    • soldair