Create and deploy a Cloud Function (2nd gen) by using the Google Cloud CLI

Create and deploy a Cloud Function (2nd gen) by using the Google Cloud CLI

Note: This content applies only to Cloud Functions (2nd gen). See Cloud Functions version comparison for more information.

For the 1st gen version of this document, see Create and deploy a Cloud Function (1st gen).

This page shows you how to create and deploy a 2nd gen Cloud Function using the Google Cloud CLI.

Before you begin

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Logging APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

9. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Logging APIs.

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

Need a command prompt? You can use the Google Cloud Shell. The Google Cloud Shell is a command line environment that already includes the Google Cloud CLI, so you don't need to install it. The Google Cloud CLI also comes preinstalled on Google Compute Engine Virtual Machines.

12. Prepare your development environment.

    Node.js

    Go to the Node.js setup guide

    Python

    Go to the Python setup guide

    Go

    Go to the Go setup guide

    Java

    Go to the Java setup guide

    C#

    Go to the .NET setup guide

    Ruby

    Go to the Ruby setup guide

    PHP

    Go to Using PHP on Google Cloud

Get the sample code

1. Clone the sample repository to your local machine:

   Node.js

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   Python

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   Go

   git clone https://github.com/GoogleCloudPlatform/golang-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   Java

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   C#

   git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   Ruby

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   PHP

   git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

2. Change to the directory that contains the Cloud Functions sample code:

   Node.js

   cd nodejs-docs-samples/functions/helloworld/helloworldGet/

   Python

   cd python-docs-samples/functions/helloworld/

   Go

   cd golang-samples/functions/functionsv2/helloworld/

   Java

   cd java-docs-samples/functions/helloworld/helloworld/

   C#

   cd dotnet-docs-samples/functions/helloworld/HelloWorld/

   Ruby

   cd ruby-docs-samples/functions/helloworld/get/

   PHP

   cd php-docs-samples/functions/helloworld_get/

3. Take a look at the sample code:

   Node.js

   functions/helloworld/helloworldGet/index.js

   View on GitHub Feedback

   const functions = require('@google-cloud/functions-framework');
   
   // Register an HTTP function with the Functions Framework that will be executed
   // when you make an HTTP request to the deployed function's endpoint.
   functions.http('helloGET', (req, res) => {
     res.send('Hello World!');
   });

   Python

   functions/helloworld/main.py

   View on GitHub Feedback

   import functions_framework
   
   @functions_framework.http
   def hello_get(request):
       """HTTP Cloud Function.
       Args:
           request (flask.Request): The request object.
           <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
       Note:
           For more information on how Flask integrates with Cloud
           Functions, see the `Writing HTTP functions` page.
           <https://cloud.google.com/functions/docs/writing/http#http_frameworks>
       """
       return 'Hello World!'

   Go

   functions/functionsv2/helloworld/hello_world.go

   View on GitHub Feedback

   
   // Package helloworld provides a set of Cloud Functions samples.
   package helloworld
   
   import (
   	"fmt"
   	"net/http"
   
   	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
   )
   
   func init() {
   	functions.HTTP("HelloGet", helloGet)
   }
   
   // helloGet is an HTTP Cloud Function.
   func helloGet(w http.ResponseWriter, r *http.Request) {
   	fmt.Fprint(w, "Hello, World!")
   }
   

   Java

   functions/helloworld/helloworld/src/main/java/functions/HelloWorld.java

   View on GitHub Feedback

   
   package functions;
   
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import java.io.BufferedWriter;
   import java.io.IOException;
   
   public class HelloWorld implements HttpFunction {
     // Simple function to return "Hello World"
     @Override
     public void service(HttpRequest request, HttpResponse response)
         throws IOException {
       BufferedWriter writer = response.getWriter();
       writer.write("Hello World!");
     }
   }

   C#

   functions/helloworld/HelloWorld/Function.cs

   View on GitHub Feedback

   using Google.Cloud.Functions.Framework;
   using Microsoft.AspNetCore.Http;
   using System.Threading.Tasks;
   
   namespace HelloWorld;
   
   public class Function : IHttpFunction
   {
       public async Task HandleAsync(HttpContext context)
       {
           await context.Response.WriteAsync("Hello World!");
       }
   }

   Ruby

   functions/helloworld/get/app.rb

   View on GitHub Feedback

   require "functions_framework"
   
   FunctionsFramework.http "hello_get" do |_request|
     # The request parameter is a Rack::Request object.
     # See https://www.rubydoc.info/gems/rack/Rack/Request
   
     # Return the response body as a string.
     # You can also return a Rack::Response object, a Rack response array, or
     # a hash which will be JSON-encoded into a response.
     "Hello World!"
   end

   PHP

   functions/helloworld_get/index.php

   View on GitHub Feedback

   
   use Psr\Http\Message\ServerRequestInterface;
   
   function helloGet(ServerRequestInterface $request): string
   {
       return 'Hello, World!' . PHP_EOL;
   }
   

Deploying the function

To deploy the function with an HTTP trigger, run the following command in the directory that contains the sample code (or in the case of Java, the pom.xml file):

Node.js

gcloud functions deploy nodejs-http-function \
--gen2 \
--runtime=nodejs18 \
--region=REGION \
--source=. \
--entry-point=helloGET \
--trigger-http \
--allow-unauthenticated

You can use the following values for the --runtime flag to specify your preferred Node.js version:

• nodejs18 (recommended)
• nodejs16
• nodejs14
• nodejs12
• nodejs10

Python

gcloud functions deploy python-http-function \
--gen2 \
--runtime=python311 \
--region=REGION \
--source=. \
--entry-point=hello_get \
--trigger-http \
--allow-unauthenticated

You can use the following values for the --runtime flag to specify your preferred Python version:

• python311 (recommended)
• python310
• python39
• python38
• python37

Go

gcloud functions deploy go-http-function \
--gen2 \
--runtime=go119 \
--region=REGION \
--source=. \
--entry-point=HelloGet \
--trigger-http \
--allow-unauthenticated

You can use the following values for the --runtime flag to specify your preferred Go version:

• go119 (recommended)
• go120 (preview)
• go118
• go116
• go113

Java

gcloud functions deploy java-http-function \
--gen2 \
--runtime=java17 \
--region=REGION \
--source=. \
--entry-point=functions.HelloWorld \
--memory=512MB \
--trigger-http \
--allow-unauthenticated

You can use the following values for the --runtime flag to specify your preferred Java version:

• java17 (recommended)
• java11

C#

gcloud functions deploy csharp-http-function \
--gen2 \
--runtime=dotnet6 \
--region=REGION \
--source=. \
--entry-point=HelloWorld.Function \
--trigger-http \
--allow-unauthenticated

You can use the following values for the --runtime flag to specify your preferred .NET version:

• dotnet6 (recommended)
• dotnet3

Ruby

gcloud functions deploy ruby-http-function \
--gen2 \
--runtime=ruby30 \
--region=REGION \
--source=. \
--entry-point=hello_get \
--trigger-http \
--allow-unauthenticated

You can use the following values for the --runtime flag to specify your preferred Ruby version:

• ruby30 (recommended)
• ruby32 (preview)
• ruby27
• ruby26

PHP

gcloud functions deploy php-http-function \
--gen2 \
--runtime=php81 \
--region=REGION \
--source=. \
--entry-point=helloGet \
--trigger-http \
--allow-unauthenticated

You can use the following values for the --runtime flag to specify your preferred PHP version:

• php81 (recommended)
• php74

The --allow-unauthenticated flag lets you reach the function without authentication. To require authentication, omit the flag.

Regions

You must supply a region when you deploy a 2nd gen function. See Locations for a list of available regions. Your gcloud CLI configuration has a default region associated with it, but you can use any supported region you like in the deploy command.

To see the default region associated with your gcloud CLI configuration, run:

gcloud config list

You can change your default region as follows:

gcloud config set functions/region REGION

Note that even if you are deploying your function to your default region, you still must include the region in your deploy command line.

Triggering the function

1. When the function finishes deploying, take note of the uri property or find it using the following command:

   Node.js

   gcloud functions describe nodejs-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

   Python

   gcloud functions describe python-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

   Go

   gcloud functions describe go-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

   Java

   gcloud functions describe java-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

   C#

   gcloud functions describe csharp-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

   Ruby

   gcloud functions describe ruby-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

   PHP

   gcloud functions describe php-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

2. After editing the following command to use your own URI, run it to see a Hello World! message:

   curl -m 70 -X POST URI \
       -H "Authorization: bearer $(gcloud auth print-identity-token)" \
       -H "Content-Type: application/json" \
       -d '{}'
   

Note: Currently, function URLs in Cloud Functions (2nd gen) use a non-deterministic format, meaning you cannot predict your function URL before deployment, though the URL remains stable after deployment. In a future release, function URLs will be updated to be both stable and deterministic.

Deleting the Cloud Function

To delete the Cloud Function you created in this tutorial, run the following command:

Node.js

gcloud functions delete nodejs-http-function --gen2 --region REGION 

Python

gcloud functions delete python-http-function --gen2 --region REGION 

Go

gcloud functions delete go-http-function --gen2 --region REGION 

Java

gcloud functions delete java-http-function --gen2 --region REGION 

C#

gcloud functions delete csharp-http-function --gen2 --region REGION 

Ruby

gcloud functions delete ruby-http-function --gen2 --region REGION 

PHP

gcloud functions delete php-http-function --gen2 --region REGION 

You can also delete Cloud Functions from the Google Cloud console.

What's next

• Learn more about writing Cloud Functions.
• Learn more about deploying Cloud Functions.
• Learn more about calling Cloud Functions.
• Learn more about monitoring Cloud Functions.
• Learn more about running Cloud Functions locally.
• Explore the more advanced Cloud Functions tutorials.