Quickstart: Using the gcloud Command-Line Tool

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.

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

3. 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.
           <http://flask.pocoo.org/docs/1.0/api/#flask.Request>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>.
       """
       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!");
     }
   }

Deploy a function

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

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

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

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

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

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

Test the function

1. 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

   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

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