Create a Cloud Run function by using the Google Cloud CLI

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 Run 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

   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

   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

   
   // 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

   
   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#

   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!", context.RequestAborted);
       }
   }

   Ruby

   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

   
   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):

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

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

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

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

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

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

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

You can optionally use the --allow-unauthenticated flag to reach the function without authentication. This is useful for testing, but we don't recommend using this setting in production unless you are creating a public API or website. Further, it might not work for you, depending on your corporate policy settings. See Authenticating for invocation for details on how to invoke a function that requires authentication.

Regions

You must supply a region when you deploy a Cloud Run 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 url property or find it using the following command:

   Node.js

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

   Python

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

   Go

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

   Java

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

   C#

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

   Ruby

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

   PHP

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

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 '{}'
   

Deleting the function

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

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

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

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

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

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

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

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

You can also delete Cloud Run functions from the Google Cloud console.