-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add Cloud Tasks Readme * update endpoint and env var * remove app viewing command
- Loading branch information
1 parent
b5cbe59
commit cd9fe5b
Showing
2 changed files
with
167 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
# Google Cloud Tasks App Engine Queue Samples | ||
|
||
Sample command-line program for interacting with the Cloud Tasks API | ||
using App Engine queues. | ||
|
||
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. | ||
|
||
`CreateTask.java` is a simple command-line program to create | ||
tasks to be pushed to the App Engine app. | ||
|
||
`TaskServlet.java` is the main App Engine app. This app serves as an endpoint to receive | ||
App Engine task attempts. | ||
|
||
|
||
## Initial Setup | ||
|
||
* Set up a Google Cloud Project and enable billing. | ||
* Enable the | ||
[Cloud Tasks API](https://console.cloud.google.com/launcher/details/google/cloudtasks.googleapis.com). | ||
* Download and install the [Cloud SDK](https://cloud.google.com/sdk). | ||
* Download and install [Maven](http://maven.apache.org/install.html). | ||
|
||
## 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 Engine app | ||
[Using Maven and the App Engine Plugin](https://cloud.google.com/appengine/docs/flexible/java/using-maven) | ||
& [Maven Plugin Goals and Parameters](https://cloud.google.com/appengine/docs/flexible/java/maven-reference) | ||
|
||
### Running locally | ||
|
||
``` | ||
mvn appengine:run | ||
``` | ||
### Deploying | ||
|
||
``` | ||
mvn appengine:deploy | ||
``` | ||
|
||
## Running the Sample | ||
|
||
Set environment variables: | ||
|
||
First, your project ID: | ||
|
||
``` | ||
export GOOGLE_CLOUD_PROJECT=<YOUR_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 QUEUE_ID=my-appengine-queue | ||
``` | ||
|
||
And finally the location ID, which can be discovered with | ||
`gcloud beta tasks queues describe $QUEUE_ID`, 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=<YOUR_ZONE> | ||
``` | ||
|
||
Create a task, targeted at the `/tasks/create` endpoint, with a payload specified: | ||
|
||
``` | ||
mvn exec:java -Dexec.mainClass="com.example.task.CreateTask" \ | ||
-Dexec.args="--project-id $GOOGLE_CLOUD_PROJECT \ | ||
--queue $QUEUE_ID --location $LOCATION_ID --payload hello" | ||
``` | ||
|
||
The App Engine app serves as a target for the push requests. It has an | ||
endpoint `/tasks/create` 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: | ||
|
||
``` | ||
mvn exec:java -Dexec.mainClass="com.example.task.CreateTask" \ | ||
-Dexec.args="--project-id $GOOGLE_CLOUD_PROJECT \ | ||
--queue $QUEUE_ID --location $LOCATION_ID --payload hello --in-seconds 30" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Google Cloud Tasks Pull Queue Samples | ||
|
||
<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=tasks/README.md"> | ||
<img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> | ||
|
||
Sample command-line program for interacting with the Google Cloud Tasks | ||
API using pull queues. | ||
|
||
Pull queues let you add tasks to a queue, then programatically remove | ||
and interact with them. Tasks can be added or processed in any | ||
environment, such as on Google App Engine or Google Compute Engine. | ||
|
||
`Quickstart.java` is a simple command-line program to demonstrate listing | ||
queues, creating tasks, and pulling and acknowledging tasks. | ||
|
||
## Initial Setup | ||
|
||
* Set up a Google Cloud Project and enable billing. | ||
* Enable the | ||
[Cloud Tasks API](https://console.cloud.google.com/launcher/details/google/cloudtasks.googleapis.com). | ||
* Download and install the [Cloud SDK](https://cloud.google.com/sdk). | ||
* Download and install [Maven](http://maven.apache.org/install.html). | ||
|
||
|
||
## Creating a queue | ||
|
||
To create a queue using the Cloud SDK, use the following gcloud command: | ||
|
||
``` | ||
gcloud beta tasks queues create-pull-queue my-pull-queue | ||
``` | ||
|
||
In this example, the queue will be named `my-pull-queue`. | ||
|
||
## Running the Samples | ||
|
||
From the project folder, build your project with: | ||
|
||
``` | ||
mvn clean install | ||
``` | ||
|
||
Optionally, you can set up your settings as environment variables: | ||
|
||
``` | ||
export GOOGLE_CLOUD_PROJECT=<YOUR_PROJECT_ID> | ||
export LOCATION_ID=<YOUR_ZONE> | ||
export QUEUE_ID=my-pull-queue | ||
``` | ||
|
||
Next, create a task for a queue: | ||
|
||
``` | ||
mvn exec:java -Dexec.mainClass="com.example.Quickstart" \ | ||
-Dexec.args="create-task \ | ||
--project $GOOGLE_CLOUD_PROJECT --queue $QUEUE_ID --location $LOCATION_ID" | ||
``` | ||
|
||
Finally, pull and acknowledge a task: | ||
|
||
``` | ||
mvn exec:java -Dexec.mainClass="com.example.task.Quickstart" \ | ||
-Dexec.args="lease-and-ack-task \ | ||
--project $GOOGLE_CLOUD_PROJECT --queue $QUEUE_ID --location $LOCATION_ID" | ||
``` | ||
Note that usually, there would be a processing step in between pulling a task and acknowledging it. |