Skip to main content
Long work and waiting for your approval: read, wait for, list and cancel jobs. 4 operations. How to call them, and what the answers mean: Operations reference.
Generated from the summer-engine npm package 4.8.0: its public operation catalog (registry/operations/public-catalog.json) and its engine and local operations. If something here is wrong, the operation’s definition is wrong.

cancel

jobs.cancel: Cancel a job Stop one of the person’s jobs that has not finished: a plan agent request, a cloud build, or a publish request still waiting for the owner (its link stops working). Work already saved stays. Returns the job. Next: jobs.list. Inputs:
Example: Take back a publish request before the owner answers.

get

jobs.get: Check a job Read one job once: its state (queued, running, awaiting_approval, done, failed…), progress and, when done, its result. Next: jobs.wait to wait for it. Inputs:
Example: Is the 3D model done?

list

jobs.list: List my jobs List the person’s jobs, newest first: with planId, a plan’s agent requests and cloud builds; with gameId, its store uploads and publish requests; with neither, their asset generations of the last 48 hours and the store jobs of the five games changed last. Next: jobs.wait or jobs.cancel. Inputs:
Example: Which uploads of this game is Summer still checking?

wait

jobs.wait: Wait for a job Wait up to timeoutSeconds (at most 50) for a job to finish, then return it. If it is still not done, call again. Approvals wait for the person. Inputs:
Example: Wait for a 3D job.