Quickstart: Using the gcloud Command-Line Tool

This page shows you how to create and deploy a Cloud Function using the gcloud command-line tool.

Before you begin

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.
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
Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.
Enable the Cloud Functions and Cloud Build APIs.
Enable the APIs

Install and initialize the Cloud SDK.
Update gcloud components:
```
gcloud components update
```

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 SDK, so you don't need to install it. The Google Cloud SDK also comes preinstalled on Google Compute Engine Virtual Machines.

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

Get the sample code

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.

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

Node.js

cd nodejs-docs-samples/functions/helloworld/

Python

cd python-docs-samples/functions/helloworld/

Go

cd golang-samples/functions/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/

Take a look at the sample code:

Node.js

functions/helloworld/index.js

View on GitHub Feedback

/**
 * HTTP Cloud Function.
 * This function is exported by index.js, and is executed when
 * you make an HTTP request to the deployed function's endpoint.
 *
 * @param {Object} req Cloud Function request context.
 *                     More info: https://expressjs.com/en/api.html#req
 * @param {Object} res Cloud Function response context.
 *                     More info: https://expressjs.com/en/api.html#res
 */
exports.helloGET = (req, res) => {
  res.send('Hello World!');
};

Python

functions/helloworld/main.py

View on GitHub Feedback

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/helloworld/hello_world.go

View on GitHub Feedback


// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"fmt"
	"net/http"
)

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

Deploy a function

To deploy the function with an HTTP trigger, run the following command in the directory containing your function:

Node.js

gcloud functions deploy helloGET \
--runtime nodejs10 --trigger-http --allow-unauthenticated

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

nodejs10
nodejs12
nodejs14 (public preview)

Python

gcloud functions deploy hello_get \
--runtime python38 --trigger-http --allow-unauthenticated

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

python37
python38
python39 (public preview)

Go

gcloud functions deploy HelloGet \
--runtime go113 --trigger-http --allow-unauthenticated

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

go111 (Deprecated)
go113

Java

gcloud functions deploy java-helloworld \
--entry-point functions.HelloWorld \
--runtime java11 \
--memory 512MB --trigger-http --allow-unauthenticated

C#

gcloud functions deploy csharp-helloworld \
--entry-point HelloWorld.Function \
--runtime dotnet3 --trigger-http --allow-unauthenticated

Ruby

gcloud functions deploy hello_get --runtime ruby26 --trigger-http --allow-unauthenticated

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

ruby26
ruby27

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

Test the function

When the function finishes deploying, take note of the httpsTrigger's url property or find it using the following command:

Node.js

gcloud functions describe helloGET

Python

gcloud functions describe hello_get

Go

gcloud functions describe HelloGet

Java

gcloud functions describe java-helloworld

C#

gcloud functions describe csharp-helloworld

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

It should look like this:

Node.js

https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloGET

Python

https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_get

Go

https://GCP_REGION-PROJECT_ID.cloudfunctions.net/HelloGet

Java

https://GCP_REGION-PROJECT_ID.cloudfunctions.net/java-helloworld

C#

https://GCP_REGION-PROJECT_ID.cloudfunctions.net/csharp-helloworld

Ruby

gcloud functions describe hello_get

Visit this URL in your browser. You should see a Hello World! message.

Delete the function

To delete the function, run the following command:

Node.js

gcloud functions delete helloGET

Python

gcloud functions delete hello_get

Go

gcloud functions delete HelloGet

Java

gcloud functions delete java-helloworld

C#

gcloud functions delete csharp-helloworld

Ruby

gcloud functions delete hello_get

Quickstart: Using the gcloud Command-Line Tool

Before you begin

Node.js

Python

Go

Java

C#

Ruby

Get the sample code

Node.js

Python

Go

Java

C#

Ruby

Node.js

Python

Go

Java

C#

Ruby

Node.js

Python

Go

Java

C#

Ruby

Deploy a function

Node.js

Python

Go

Java

C#

Ruby

Test the function

Node.js

Python

Go

Java

C#

Ruby

Node.js

Python

Go

Java

C#

Ruby

Delete the function

Node.js

Python

Go

Java

C#

Ruby

What's next