-
Notifications
You must be signed in to change notification settings - Fork 220
Add docs for usage of Jobs SDK #1323
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
376a49a
Add doc for jobs
siri-varma cfa4e98
Add docs for Jobs
siri-varma a062e6c
Merge branch 'master' into users/svegiraju/add-jobs-doc
siri-varma cac826e
Merge branch 'master' into users/svegiraju/add-jobs-doc
siri-varma 2d9f727
Merge branch 'master' into users/svegiraju/add-jobs-doc
siri-varma 68a6de7
Merge branch 'master' into users/svegiraju/add-jobs-doc
siri-varma cc03ea4
Merge branch 'master' into users/svegiraju/add-jobs-doc
artur-ciocanu 7874d23
Apply suggestions from code review
siri-varma File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,7 @@ | ||
--- | ||
type: docs | ||
title: "Jobs" | ||
linkTitle: "Jobs" | ||
weight: 3000 | ||
description: With the Dapr Jobs package, you can interact with the Dapr Jobs APIs from a Java application to trigger future operations to run according to a predefined schedule with an optional payload. To get started, walk through the [Dapr Jobs]({{< ref java-jobs-howto.md >}}) how-to guide. | ||
--- |
164 changes: 164 additions & 0 deletions
164
daprdocs/content/en/java-sdk-docs/java-jobs/java-jobs-howto.md
This file contains hidden or 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,164 @@ | ||
--- | ||
type: docs | ||
title: "How to: Author and manage Dapr Jobs in the Java SDK" | ||
linkTitle: "How to: Author and manage Jobs" | ||
weight: 20000 | ||
description: How to get up and running with Jobs using the Dapr Java SDK | ||
--- | ||
|
||
As part of this demonstration we will schedule a Dapr Job. The scheduled job will trigger an endpoint registered in the | ||
same app. With the [provided jobs example](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/jobs), you will: | ||
|
||
- Schedule a Job [Job scheduling example](https://github.com/dapr/java-sdk/blob/master/examples/src/main/java/io/dapr/examples/jobs/DemoJobsClient.java) | ||
- Register an endpoint for the dapr sidecar to invoke at trigger time [Endpoint Registration](https://github.com/dapr/java-sdk/blob/master/examples/src/main/java/io/dapr/examples/jobs/DemoJobsSpringApplication.java) | ||
|
||
This example uses the default configuration from `dapr init` in [self-hosted mode](https://github.com/dapr/cli#install-dapr-on-your-local-machine-self-hosted). | ||
|
||
## Prerequisites | ||
|
||
- [Dapr CLI and initialized environment](https://docs.dapr.io/getting-started). | ||
- Java JDK 11 (or greater): | ||
- [Oracle JDK](https://www.oracle.com/java/technologies/downloads), or | ||
- OpenJDK | ||
- [Apache Maven](https://maven.apache.org/install.html), version 3.x. | ||
- [Docker Desktop](https://www.docker.com/products/docker-desktop) | ||
|
||
## Set up the environment | ||
|
||
Clone the [Java SDK repo](https://github.com/dapr/java-sdk) and navigate into it. | ||
|
||
```bash | ||
git clone https://github.com/dapr/java-sdk.git | ||
cd java-sdk | ||
``` | ||
|
||
Run the following command to install the requirements for running the jobs example with the Dapr Java SDK. | ||
|
||
```bash | ||
mvn clean install -DskipTests | ||
``` | ||
|
||
From the Java SDK root directory, navigate to the Dapr Jobs example. | ||
|
||
```bash | ||
cd examples | ||
``` | ||
|
||
Run the Dapr sidecar. | ||
|
||
```sh | ||
dapr run --app-id jobsapp --dapr-grpc-port 51439 --dapr-http-port 3500 --app-port 8080 | ||
``` | ||
|
||
> Now, Dapr is listening for HTTP requests at `http://localhost:3500` and internal Jobs gRPC requests at `http://localhost:51439`. | ||
|
||
## Schedule and Get a job | ||
|
||
In the `DemoJobsClient` there are steps to schedule a job. Calling `scheduleJob` using the `DaprPreviewClient` | ||
will schedule a job with the Dapr Runtime. | ||
|
||
```java | ||
public class DemoJobsClient { | ||
|
||
/** | ||
* The main method of this app to schedule and get jobs. | ||
*/ | ||
public static void main(String[] args) throws Exception { | ||
try (DaprPreviewClient client = new DaprClientBuilder().withPropertyOverrides(overrides).buildPreviewClient()) { | ||
|
||
// Schedule a job. | ||
System.out.println("**** Scheduling a Job with name dapr-jobs-1 *****"); | ||
ScheduleJobRequest scheduleJobRequest = new ScheduleJobRequest("dapr-job-1", | ||
JobSchedule.fromString("* * * * * *")).setData("Hello World!".getBytes()); | ||
client.scheduleJob(scheduleJobRequest).block(); | ||
|
||
System.out.println("**** Scheduling job dapr-jobs-1 completed *****"); | ||
} | ||
} | ||
} | ||
``` | ||
|
||
Call `getJob` to retrieve the job details that were previously created and scheduled. | ||
``` | ||
client.getJob(new GetJobRequest("dapr-job-1")).block() | ||
``` | ||
|
||
Run the `DemoJobsClient` with the following command. | ||
|
||
```sh | ||
java -jar target/dapr-java-sdk-examples-exec.jar io.dapr.examples.jobs.DemoJobsClient | ||
``` | ||
|
||
### Sample output | ||
``` | ||
**** Scheduling a Job with name dapr-jobs-1 ***** | ||
**** Scheduling job dapr-jobs-1 completed ***** | ||
**** Retrieving a Job with name dapr-jobs-1 ***** | ||
``` | ||
|
||
## Set up an endpoint to be invoked when the job is triggered | ||
|
||
The `DemoJobsSpringApplication` class starts a Spring Boot application that registers the endpoints specified in the `JobsController` | ||
This endpoint acts like a callback for the scheduled job requests. | ||
|
||
```java | ||
@RestController | ||
public class JobsController { | ||
|
||
/** | ||
* Handles jobs callback from Dapr. | ||
* | ||
* @param jobName name of the job. | ||
* @param payload data from the job if payload exists. | ||
* @return Empty Mono. | ||
*/ | ||
@PostMapping("/job/{jobName}") | ||
public Mono<Void> handleJob(@PathVariable("jobName") String jobName, | ||
@RequestBody(required = false) byte[] payload) { | ||
System.out.println("Job Name: " + jobName); | ||
System.out.println("Job Payload: " + new String(payload)); | ||
|
||
return Mono.empty(); | ||
} | ||
} | ||
``` | ||
|
||
Parameters: | ||
|
||
* `jobName`: The name of the triggered job. | ||
* `payload`: Optional payload data associated with the job (as a byte array). | ||
|
||
Run the Spring Boot application with the following command. | ||
|
||
```sh | ||
java -jar target/dapr-java-sdk-examples-exec.jar io.dapr.examples.jobs.DemoJobsSpringApplication | ||
``` | ||
|
||
### Sample output | ||
``` | ||
Job Name: dapr-job-1 | ||
Job Payload: Hello World! | ||
``` | ||
|
||
## Delete a scheduled job | ||
|
||
```java | ||
public class DemoJobsClient { | ||
|
||
/** | ||
* The main method of this app deletes a job that was previously scheduled. | ||
*/ | ||
public static void main(String[] args) throws Exception { | ||
try (DaprPreviewClient client = new DaprClientBuilder().buildPreviewClient()) { | ||
|
||
// Delete a job. | ||
System.out.println("**** Delete a Job with name dapr-jobs-1 *****"); | ||
client.deleteJob(new DeleteJobRequest("dapr-job-1")).block(); | ||
} | ||
} | ||
} | ||
``` | ||
|
||
## Next steps | ||
- [Learn more about Jobs]({{< ref jobs-overview.md >}}) | ||
- [Jobs API reference]({{< ref jobs_api.md >}}) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.