Skip to main content

JobService (gRPC)

Generated content. This page is produced by cargo run --bin gen_docs (src-tauri/src/bin/gen_docs/) reading proto/maslow/v1/*.proto's compiled FileDescriptorSet, via prost-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

GetSavedJob

StartJob

PauseJob

ResumeJob

StopJob

WatchJobProgress

Types

Every message and enum reachable from this service's requests and responses, including shared types defined in common.proto.

GetJobRequest

FieldTypeDescription
namestring"jobs/current"

GetSavedJobRequest

No fields.

GetSavedJobResponse

FieldTypeDescription
saved_jobSavedJobUnset 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.

FieldTypeDescription
statestring"running" | "paused" | "interrupted" | "done" | "error" | "idle"
pathstring
namestring
sentuint64
ackeduint64
totaluint64
errorsuint64

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.

FieldTypeDescription
pathstring
namestring
totaluint64
ackeduint64
statestring
updated_atuint64

StartJobRequest

FieldTypeDescription
pathstring
start_indexuint64

StartJobResponse

FieldTypeDescription
totaluint64

StopJobRequest

No fields.

WatchJobProgressRequest

No fields.