4.9 KiB

Raw Blame History

Dapr Jobs

In this quickstart, you'll schedule, get, and delete a job using Dapr's Job API. This API is responsible for scheduling and running jobs at a specific time or interval.

Visit this link for more information about Dapr and the Jobs API.

Note: This example leverages HTTP requests only. If you are looking for the example using the Dapr Client SDK (recommended) click here.

This quickstart includes two apps:

job-scheduler.go, responsible for scheduling, retrieving and deleting jobs.
job-service.go, responsible for handling the triggered jobs.

Run the app with the template file

This section shows how to run both applications at once using multi-app run template files with dapr run -f .. This enables to you test the interactions between multiple applications and will schedule, run, get, and delete jobs within a single process.

Open a new terminal window and run the multi app run template:

dapr run -f .

The terminal console output should look similar to this, where:

The R2-D2 job is being scheduled.
The R2-D2 job is being executed after 2 seconds.
The C-3PO job is being scheduled.
The C-3PO job is being retrieved.

== APP - job-scheduler == Job Scheduled: R2-D2
== APP - job-service == Received job request...
== APP - job-service == Starting droid: R2-D2
== APP - job-service == Executing maintenance job: Oil Change
== APP - job-scheduler == Job Scheduled: C-3PO
== APP - job-scheduler == Job details: {"name":"C-3PO", "dueTime":"30s", "data":{"@type":"ttype.googleapis.com/google.protobuf.StringValue", "expression":"C-3PO:Limb Calibration"}}

After 30 seconds, the terminal output should present the C-3PO job being processed:

== APP - job-service == Received job request...
== APP - job-service == Starting droid: C-3PO
== APP - job-service == Executing maintenance job: Limb Calibration

Stop and clean up application processes

dapr stop -f .

Run the Jobs APIs individually

Schedule Jobs

Open a terminal and run the job-service app:

dapr run --app-id job-service --app-port 6200 --dapr-http-port 6280 -- go run .

On a new terminal window, schedule the R2-D2 Job using the Jobs API.

curl -X POST \
  http://localhost:6280/v1.0-alpha1/jobs/R2D2 \
  -H "Content-Type: application/json" \
  -d '{
        "data": {
          "@type": "type.googleapis.com/google.protobuf.StringValue",
          "value": "R2-D2:Oil Change"
        },
        "dueTime": "2s"
    }'

Back at the job-service app terminal window, the output should be:

== APP - job-app == Received job request...
== APP - job-app == Starting droid: R2-D2
== APP - job-app == Executing maintenance job: Oil Change

On the same terminal window, schedule the C-3PO Job using the Jobs API.

curl -X POST \
  http://localhost:6280/v1.0-alpha1/jobs/c-3po \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "@type": "type.googleapis.com/google.protobuf.StringValue",
      "value": "C-3PO:Limb Calibration"
    },
    "dueTime": "30s"
  }'

Get a scheduled job

On the same terminal window, run the command below to get the recently scheduled C-3PO job.

curl -X GET http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"

You should see the following:

{"name":"C-3PO", "dueTime":"30s", "data":{"@type":"type.googleapis.com/google.protobuf.StringValue", "expression":"C-3PO:Limb Calibration"}}

Delete a scheduled job

On the same terminal window, run the command below to deleted the recently scheduled C-3PO job.

curl -X DELETE http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"

Run the command below to attempt to retrieve the deleted job:

curl -X GET http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"