Cloud Storage Tutorial

This simple tutorial demonstrates writing, deploying, and triggering a Background Cloud Function with a Cloud Storage trigger.

Objectives

Costs

This tutorial uses billable components of Cloud Platform, including:

  • Google Cloud Functions
  • Google Cloud Storage

Use the Pricing Calculator to generate a cost estimate based on your projected usage.

New Cloud Platform users might be eligible for a free trial.

Before you begin

  1. Sign in to your Google account.

    If you don't already have one, sign up for a new account.

  2. Select or create a Cloud Platform project.

    Go to the Manage resources page

  3. Enable billing for your project.

    Enable billing

  4. Enable the Cloud Functions and Cloud Storage APIs.

    Enable the APIs

  5. Install and initialize the Cloud SDK.
  6. Update and install gcloud components:
    gcloud components update &&
    gcloud components install beta
  7. Prepare your environment for Node.js development.

    Go to the setup guide

Preparing the application

  1. Create a Cloud Storage bucket to stage your Cloud Functions files, where [YOUR_STAGING_BUCKET_NAME] is a globally unique bucket name:

    gsutil mb gs://[YOUR_STAGING_BUCKET_NAME]
    

  2. Create a Cloud Storage bucket to upload a test file, where [YOUR_UPLOAD_BUCKET_NAME] is a globally unique bucket name:

    gsutil mb gs://[YOUR_UPLOAD_BUCKET_NAME]
    

  3. Create a directory on your local system for the application code:

    Linux or Mac OS X

    Create the directory:

    mkdir ~/gcf_gcs

    Move into the directory:

    cd ~/gcf_gcs

    Windows

    Create the directory:

    mkdir %HOMEPATH%\gcf_gcs

    Move into the directory:

    cd %HOMEPATH%\gcf_gcs

  4. Create an index.js file in the gcf_gcs directory with the following contents:

    Node.js

    /**
     * Background Cloud Function to be triggered by Cloud Storage.
     *
     * @param {object} event The Cloud Functions event.
     * @param {function} callback The callback function.
     */
    exports.helloGCS = function (event, callback) {
      const file = event.data;
    
      if (file.resourceState === 'not_exists') {
        console.log(`File ${file.name} deleted.`);
      } else if (file.metageneration === '1') {
        // metageneration attribute is updated on metadata changes.
        // on create value is 1
        console.log(`File ${file.name} uploaded.`);
      } else {
        console.log(`File ${file.name} metadata updated.`);
      }
    
      callback();
    };

    The helloGCS function is exported by the module and is executed when an object is added to the bucket, deleted from the bucket, or its metadata changes.

Deploying the function

To deploy the helloGCS function with a Cloud Storage trigger, run the following command in the gcf_gcs directory:

gcloud beta functions deploy helloGCS --stage-bucket [YOUR_STAGING_BUCKET_NAME] --trigger-bucket [YOUR_UPLOAD_BUCKET_NAME]

where

  • [YOUR_STAGING_BUCKET_NAME] is the name of your staging Cloud Storage Bucket.
  • [YOUR_UPLOAD_BUCKET_NAME] is the name of your Cloud Storage Bucket where you will upload a test file.

Triggering the function

  1. Create an empty gcf-test.txt file in the gcf_gcs directory.

  2. Upload the file to Cloud Storage in order to trigger the function:

    gsutil cp gcf-test.txt gs://[YOUR_UPLOAD_BUCKET_NAME]
    

    where [YOUR_UPLOAD_BUCKET_NAME] is the name of your Cloud Storage bucket where you will upload a test file.

  3. Watch the logs to be sure the executions have completed:

    gcloud beta functions logs read --limit 50
    

Cleaning up

To avoid incurring charges to your Google Cloud Platform account for the resources used in this tutorial:

Deleting the project

The easiest way to eliminate billing is to delete the project you created for the tutorial.

To delete the project:

  1. In the Cloud Platform Console, go to the Projects page.

    Go to the Projects page

  2. In the project list, select the project you want to delete and click Delete project. After selecting the checkbox next to the project name, click
      Delete project
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Deleting the Cloud Functions

Deleting Cloud Functions does not remove any resources stored in Cloud Storage.

To delete a Cloud Function, run the following command:

gcloud beta functions delete [NAME_OF_FUNCTION]

where [NAME_OF_FUNCTION] is the name of the function to delete.

You can also delete Cloud Functions from the Google Cloud Platform Console.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Cloud Functions Documentation