JobService (gRPC)
Generated content. This page is produced by
cargo run --bin gen_docs(src-tauri/src/bin/gen_docs/) readingproto/maslow/v1/*.proto's compiledFileDescriptorSet, viaprost-reflect, re-run on every docs-site build. Do not hand-edit it: fix the generator or the source it reads instead.
Kept as its own streaming RPC, separate from MachineService's WatchMachineEvents: job progress fires at high frequency while a job runs, and most telemetry-only consumers don't want it interleaved with the rest of the machine event stream.
Full name: maslow.v1.JobService
Methods
GetJob
- Kind: unary
- Request:
GetJobRequest - Response:
Job
GetSavedJob
- Kind: unary
- Request:
GetSavedJobRequest - Response:
GetSavedJobResponse
StartJob
- Kind: unary
- Request:
StartJobRequest - Response:
StartJobResponse
PauseJob
- Kind: unary
- Request:
PauseJobRequest - Response:
Job
ResumeJob
- Kind: unary
- Request:
ResumeJobRequest - Response:
Job
StopJob
- Kind: unary
- Request:
StopJobRequest - Response:
Job
WatchJobProgress
- Kind: server streaming
- Request:
WatchJobProgressRequest - Response:
Job(a stream of these)
Types
Every message and enum reachable from this service's requests and responses, including shared types defined in common.proto.
GetJobRequest
| Field | Type | Description |
|---|---|---|
name | string | "jobs/current" |
GetSavedJobRequest
No fields.
GetSavedJobResponse
| Field | Type | Description |
|---|---|---|
saved_job | SavedJob | Unset when there is no resumable job. (part of oneof _saved_job) |
Job
Live state of the active (or most recently active) job. "jobs/current" is a singleton resource: there is at most one job streaming at a time.
| Field | Type | Description |
|---|---|---|
state | string | "running" | "paused" | "interrupted" | "done" | "error" | "idle" |
path | string | |
name | string | |
sent | uint64 | |
acked | uint64 | |
total | uint64 | |
errors | uint64 |
PauseJobRequest
No fields.
ResumeJobRequest
No fields.
SavedJob
An on-disk record of a job interrupted by a disconnect or app restart,
resumable via StartJob with the same path and this record's acked as
the start index.
| Field | Type | Description |
|---|---|---|
path | string | |
name | string | |
total | uint64 | |
acked | uint64 | |
state | string | |
updated_at | uint64 |
StartJobRequest
| Field | Type | Description |
|---|---|---|
path | string | |
start_index | uint64 |
StartJobResponse
| Field | Type | Description |
|---|---|---|
total | uint64 |
StopJobRequest
No fields.
WatchJobProgressRequest
No fields.