Skip to content

Commit

Permalink
Update comments in Task samples (#1418)
Browse files Browse the repository at this point in the history
  • Loading branch information
averikitsch authored May 14, 2019
1 parent 0730123 commit 9e9120a
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 31 deletions.
50 changes: 21 additions & 29 deletions tasks/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
# Google Cloud Tasks App Engine Queue Samples
# Google Cloud Tasks 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.
This sample demonstrates using the Cloud Tasks client library.

`CreateHTTPTask.java` constructs a task with an HTTP target and pushes it
to your queue.

`CreateHTTPTask.java` constructs a task with an HTTP target and OIDC token and pushes it
to your queue.
`CreateHTTPTask.java` constructs a task with an HTTP target and OIDC token and
pushes it to your queue.

## Initial Setup

Expand All @@ -27,18 +22,7 @@ to your queue.
To create a queue using the Cloud SDK, use the following gcloud command:

```
gcloud beta tasks queues create-app-engine-queue my-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)

```
mvn appengine:deploy
gcloud beta tasks queues create <QUEUE_NAME>
```

## Run the Sample Using the Command Line
Expand All @@ -61,7 +45,7 @@ export QUEUE_ID=my-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
"projects/my-project/locations/us-central1/queues/my-queue", then the
location is "us-central1").

```
Expand All @@ -71,24 +55,32 @@ export LOCATION_ID=<YOUR_ZONE>
### Using HTTP Push Queues

Set an environment variable for the endpoint to your task handler. This is an
example url to send requests to the App Engine task handler:
example url:
```
export URL=https://${PROJECT_ID}.appspot.com/tasks/create
export URL=https://example.com/taskshandler
```

Running the sample will create a task and send the task to the specific URL
endpoint, with a payload specified:
Running the sample will create a task and add it to your queue. As the queue
processes each task, it will send the task to the specific URL endpoint:

```
mvn exec:java@HttpTask"
```

### Using HTTP Targets with Authentication Headers
### Using HTTP Targets with Authentication Tokens

Your Cloud Tasks [service account][sa],
(service-<project-number>@gcp-sa-cloudtasks.iam.gserviceaccount.com), must
have the role of: `Service Account Token Creator` to generate a tokens.

In `CreateHttpTaskWithToken.java`, add your service account email in place of
`<SERVICE_ACCOUNT_EMAIL>` to authenticate the OIDC token.
Create or use an existing [service account][sa] to replace `<SERVICE_ACCOUNT_EMAIL>`
in `CreateHttpTaskWithToken.java`. This service account will be used to
authenticate the OIDC token.

Running the sample with command:
```
mvn exec:java@WithToken"
```


[sa]: https://cloud.google.com/iam/docs/service-accounts
2 changes: 1 addition & 1 deletion tasks/src/main/java/com/example/task/CreateHttpTask.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public static void main(String[] args) throws Exception {
// projectId = "my-project-id";
// queueName = "my-queue";
// location = "us-central1";
// url = "https://example.com/hellohandler";
// url = "https://example.com/taskhandler";
String payload = "hello";

// Construct the fully qualified queue name.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public static void main(String[] args) throws Exception {
// projectId = "my-project-id";
// queueName = "my-appengine-queue";

This comment has been minimized.

Copy link
@MaxRossGoogle

MaxRossGoogle May 15, 2019

Contributor

I think you want to adjust the name of this queue as well.

// location = "us-central1";
// url = "https://example.com/tasks/create";
// url = "https://example.com/taskhandler";
String payload = "hello";

// Construct the fully qualified queue name.
Expand Down

0 comments on commit 9e9120a

Please sign in to comment.