REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
For more information, please visit https://queueflow.dev
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 0.1.0
- Generator version: 7.10.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Put the package under your project folder in a directory named queueflow and add the following to Cargo.toml under [dependencies]:
queueflow = { path = "./queueflow" }
All URIs are relative to http://localhost:8000
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CronApi | create_cron | POST /api/v1/cron | |
| CronApi | delete_cron | DELETE /api/v1/cron/{id} | |
| CronApi | get_cron | GET /api/v1/cron/{id} | |
| CronApi | list_crons | GET /api/v1/cron | |
| CronApi | pause_cron | POST /api/v1/cron/{id}/pause | |
| CronApi | resume_cron | POST /api/v1/cron/{id}/resume | |
| DlqApi | get_dead_letter | GET /api/v1/dlq/{id} | |
| DlqApi | list_dead_letters | GET /api/v1/dlq | |
| DlqApi | replay_dead_letter | POST /api/v1/dlq/{id}/replay | |
| HealthApi | get_health | GET /health | |
| HealthApi | get_ready | GET /ready | |
| JobsApi | cancel_job | POST /api/v1/jobs/{id}/cancel | |
| JobsApi | create_batch_jobs | POST /api/v1/jobs/batch | |
| JobsApi | create_job | POST /api/v1/jobs | |
| JobsApi | get_job | GET /api/v1/jobs/{id} | |
| JobsApi | list_jobs | GET /api/v1/jobs | |
| JobsApi | stream_job_events | GET /api/v1/jobs/{id}/events | Stream a job's status transitions as Server-Sent Events until it reaches a terminal state. Lets clients await completion without polling the REST endpoint themselves. |
| SystemApi | get_stats | GET /api/v1/stats | |
| SystemApi | list_tasks | GET /api/v1/tasks | |
| WorkerApi | complete_job | POST /api/v1/jobs/{id}/complete | |
| WorkerApi | fail_job | POST /api/v1/jobs/{id}/fail | |
| WorkerApi | heartbeat_job | POST /api/v1/jobs/{id}/heartbeat | |
| WorkerApi | lease_jobs | POST /api/v1/queues/{queue}/lease | |
| WorkflowsApi | cancel_workflow | POST /api/v1/workflows/{id}/cancel | |
| WorkflowsApi | create_workflow | POST /api/v1/workflows | |
| WorkflowsApi | get_workflow | GET /api/v1/workflows/{id} | |
| WorkflowsApi | get_workflow_diagram | GET /api/v1/workflows/{id}/diagram | |
| WorkflowsApi | list_workflows | GET /api/v1/workflows |
- BackoffStrategy
- CompleteJobRequest
- CreateBatchJobsRequest
- CreateBatchJobsResponse
- CreateCronRequest
- CreateCronResponse
- CreateJobRequest
- CreateJobResponse
- CreateWorkflowRequest
- CreateWorkflowResponse
- CronSchedule
- DeadLetter
- ErrorBody
- FailJobRequest
- HealthStatus
- HeartbeatRequest
- HeartbeatResponse
- Job
- JobConfig
- JobConfigRequest
- JobStatus
- LeaseJobsRequest
- LeaseJobsResponse
- LeasedJob
- ListCronsResponse
- ListDeadLettersResponse
- ListJobsResponse
- ListWorkflowsResponse
- OnFailure
- OnSuccess
- ReadyStatus
- ReplayDeadLetterResponse
- StatsSnapshot
- TasksResponse
- Workflow
- WorkflowDiagramResponse
- WorkflowStatus
- WorkflowStep
To get access to the crate's generated documentation, use:
cargo doc --open