Skip to content

Latest commit

 

History

History
 
 

cloudtasks

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

C# Google Cloud Tasks sample for Google App Engine

This sample application shows how to use Google Cloud Tasks on Google App Engine flexible environment.

App Engine queues push tasks to an App Engine HTTP target. This directory contains both the App Engine app to deploy, as well as the snippets to run locally to push tasks to it, which could also be called on App Engine.

The TasksSample project contains a simple command-line program that creates tasks to be pushed to the App Engine app.

CloudTasks is the main App Engine app. This app serves as an endpoint to receive App Engine task attempts.

app.yaml configures the app for the App Engine C# flexible environment.

Setup

Before you can run or deploy the sample, you need to do the following:

  1. Refer to the appengine/README.md file for instructions on running and deploying.

  2. Enable the Cloud Tasks API in the Google Cloud Console.

  3. Set up Google Application Credentials.

  4. Install dependencies:

    dotnet restore
    

Creating a queue

To create a queue using the Cloud SDK, use the following gcloud command:

gcloud beta tasks queues create-app-engine-queue my-appengine-queue

Note: A newly created queue will route to the default App Engine service and version unless configured to do otherwise.

Deploying the app to App Engine flexible environment

Move into the App Engine folder:

cd appengine

Deploy the App Engine app with gcloud:

```psm1
PS > dotnet restore
PS > dotnet publish
PS > gcloud beta app deploy .\bin\Debug\netcoreapp2.1\publish\app.yaml
```

Verify the index page is serving:

gcloud app browse

Run the Sample Using the Command Line

Set environment variables:

First, your project ID:

export GOOGLE_CLOUD_PROJECT=my-project-id

Then the queue ID, as specified at queue creation time. Queue IDs already created can be listed with gcloud beta tasks queues list.

export GCP_QUEUE=my-appengine-queue

And finally the location ID, which can be discovered with gcloud beta tasks queues describe $GCP_QUEUE, with the location embedded in the "name" value (for instance, if the name is "projects/my-project/locations/us-central1/queues/my-appengine-queue", then the location is "us-central1").

export LOCATION_ID=us-central1

Move into the Tasks Sample folder:

cd ../api/TasksSample

Create a task, targeted at the log_payload endpoint, with a payload specified:

dotnet run createTask --project=$PROJECT_ID --queue=$GCP_QUEUE --location=$LOCATION_ID --payload=hello

The App Engine app serves as a target for the push requests. It has an endpoint /log_payload that reads the payload (i.e., the request body) of the HTTP POST request and logs it. The log output can be viewed with:

gcloud app logs read

Create a task that will be scheduled for a time in the future using the --in_seconds flag:

dotnet run createTask --project=$PROJECT_ID --queue=$GCP_QUEUE --location=$LOCATION_ID --payload=hello --in_seconds=30

Usage information

-i, --projectId    Required. Project ID of the queue to add the task to.
-l, --location     Required. Location of the queue to add the task to.
-q, --queue        Required. Location of the queue to add the task to.
-d, --payload      (Default: ) (Optional) Payload to attach to the push queue.
-s, --inSeconds    (Default: 0) (Optional) The number of seconds from now to schedule task attempt.
--help             Display this help screen.
  --version          Display version information.