@google-cloud/run

Cloud Run: Node.js Client

Cloud Run Admin API

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Cloud Run Node.js Client API Reference
• Cloud Run Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-run

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Cloud Run 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/run

Using the client library

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The location and project to list resources on.
 *  Location must be a valid GCP region, and may not be the "-" wildcard.
 *  Format: projects/{projectnumber}/locations/{location}
 */
// const parent = 'abc123'
/**
 *  Maximum number of Services to return in this call.
 */
// const pageSize = 1234
/**
 *  A page token received from a previous call to ListServices.
 *  All other parameters must match.
 */
// const pageToken = 'abc123'

/**
 *  If true, returns deleted (but unexpired) resources along with active ones.
 */
// const showDeleted = true
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;

// Instantiates a client
const runClient = new ServicesClient();

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

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

callListServices();

Samples

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

Sample	Source Code	Try it
Executions.cancel_execution	source code
Executions.delete_execution	source code
Executions.get_execution	source code
Executions.list_executions	source code
Jobs.create_job	source code
Jobs.delete_job	source code
Jobs.get_iam_policy	source code
Jobs.get_job	source code
Jobs.list_jobs	source code
Jobs.run_job	source code
Jobs.set_iam_policy	source code
Jobs.test_iam_permissions	source code
Jobs.update_job	source code
Revisions.delete_revision	source code
Revisions.get_revision	source code
Revisions.list_revisions	source code
Services.create_service	source code
Services.delete_service	source code
Services.get_iam_policy	source code
Services.get_service	source code
Services.list_services	source code
Services.set_iam_policy	source code
Services.test_iam_permissions	source code
Services.update_service	source code
Tasks.get_task	source code
Tasks.list_tasks	source code
Quickstart	source code

The Cloud Run 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/run@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