Google Cloud Functions: Node.js Client

Functions 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 the Google Cloud Functions API .
Set up authentication so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/functions

Using the client library

 // Imports the Google Cloud client library

// remove this line after package is released
// eslint-disable-next-line node/no-missing-require
const {CloudFunctionsServiceClient} = require(' @google-cloud/functions 
');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'

// Creates a client
const client = new CloudFunctionsServiceClient 
();

// project = 'my-project/*/locations/*' // Get the functions for a project.
async function listFunctions() {
  const [functions] = await client.listFunctions({
    parent: `projects/${projectId}/locations/-`,
  });
  console.info(functions);
}
listFunctions();

Samples

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

Sample	Source Code	Try it
Cloud_functions_service.call_function	source code
Cloud_functions_service.create_function	source code
Cloud_functions_service.delete_function	source code
Cloud_functions_service.generate_download_url	source code
Cloud_functions_service.generate_upload_url	source code
Cloud_functions_service.get_function	source code
Cloud_functions_service.get_iam_policy	source code
Cloud_functions_service.list_functions	source code
Cloud_functions_service.set_iam_policy	source code
Cloud_functions_service.test_iam_permissions	source code
Cloud_functions_service.update_function	source code
Function_service.create_function	source code
Function_service.delete_function	source code
Function_service.generate_download_url	source code
Function_service.generate_upload_url	source code
Function_service.get_function	source code
Function_service.list_functions	source code
Function_service.list_runtimes	source code
Function_service.update_function	source code
Function_service.create_function	source code
Function_service.delete_function	source code
Function_service.generate_download_url	source code
Function_service.generate_upload_url	source code
Function_service.get_function	source code
Function_service.list_functions	source code
Function_service.list_runtimes	source code
Function_service.update_function	source code
Function_service.create_function	source code
Function_service.delete_function	source code
Function_service.generate_download_url	source code
Function_service.generate_upload_url	source code
Function_service.get_function	source code
Function_service.list_functions	source code
Function_service.list_runtimes	source code
Function_service.update_function	source code
Quickstart	source code

The Google Cloud Functions 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/functions@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