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

    0.2.0 • Public • Published

    Google Cloud Platform logo

    Google Cloud Deploy: Node.js Client

    release level npm version codecov

    clouddeploy 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 Google Cloud Deploy 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/deploy

    Using the client library

    /**
     * TODO(developer): Uncomment these variables before running the sample.
     */
    /**
     *  Required. The parent, which owns this collection of pipelines. Format must be
     *  projects/{project_id}/locations/{location_name}.
     */
    // const parent = 'abc123'
    /**
     *  The maximum number of pipelines to return. The service may return
     *  fewer than this value. If unspecified, at most 50 pipelines will
     *  be returned. The maximum value is 1000; values above 1000 will be set
     *  to 1000.
     */
    // const pageSize = 1234
    /**
     *  A page token, received from a previous `ListDeliveryPipelines` call.
     *  Provide this to retrieve the subsequent page.
     *  When paginating, all other provided parameters match
     *  the call that provided the page token.
     */
    // const pageToken = 'abc123'
    /**
     *  Filter builds to be returned. See https://google.aip.dev/160 for more
     *  details.
     */
    // const filter = 'abc123'
    /**
     *  Field to sort by. See https://google.aip.dev/132#ordering for more details.
     */
    // const orderBy = 'abc123'
    
    // Imports the Deploy library
    const {CloudDeployClient} = require('@google-cloud/deploy').v1;
    
    // Instantiates a client
    const deployClient = new CloudDeployClient();
    
    async function listDeliveryPipelines() {
      // Construct request
      const request = {
        parent,
      };
    
      // Run request
      const iterable = await deployClient.listDeliveryPipelinesAsync(request);
      for await (const response of iterable) {
        console.log(response);
      }
    }
    
    listDeliveryPipelines();

    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 Google Cloud Deploy 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.

    Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

    Legacy Node.js versions are supported as a best effort:

    • Legacy versions will not be tested in continuous integration.
    • Some security patches may not be able to be backported.
    • Dependencies will not be kept up-to-date, and features will not be backported.

    Legacy tags available

    • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

    Versioning

    This library follows Semantic Versioning.

    This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high 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/deploy

    DownloadsWeekly Downloads

    6

    Version

    0.2.0

    License

    Apache-2.0

    Unpacked Size

    2.46 MB

    Total Files

    18

    Last publish

    Collaborators

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