Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/windmill/mod.ts>JobService

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Go to Latest
class JobService
Re-export
import { JobService } from "https://deno.land/x/windmill@v1.265.1/mod.ts";

Static Methods

cancelAll(unnamed 0: { workspace: string; }): CancelablePromise<Array<string>>

cancel all jobs

cancelPersistentQueuedJobs(unnamed 0: { workspace: string; path: string; requestBody: { reason?: string; }; }): CancelablePromise<string>

cancel all queued jobs for persistent script

cancelQueuedJob(unnamed 0: { workspace: string; id: string; requestBody: { reason?: string; }; }): CancelablePromise<string>

cancel queued job

cancelSuspendedJobGet(unnamed 0: { workspace: string; id: string; resumeId: number; signature: string; approver?: string; }): CancelablePromise<string>

cancel a job for a suspended flow

cancelSuspendedJobPost(unnamed 0: { workspace: string; id: string; resumeId: number; signature: string; requestBody: any; approver?: string; }): CancelablePromise<string>

cancel a job for a suspended flow

createJobSignature(unnamed 0: { workspace: string; id: string; resumeId: number; approver?: string; }): CancelablePromise<string>

create an HMac signature given a job id and a resume id

deleteCompletedJob(unnamed 0: { workspace: string; id: string; }): CancelablePromise<CompletedJob>

delete completed job (erase content but keep run id)

forceCancelQueuedJob(unnamed 0: { workspace: string; id: string; requestBody: { reason?: string; }; }): CancelablePromise<string>

force cancel queued job

getCompletedCount(unnamed 0: { workspace: string; }): CancelablePromise<{ database_length: number; }>

get completed count

getCompletedJob(unnamed 0: { workspace: string; id: string; }): CancelablePromise<CompletedJob>

get completed job

getCompletedJobResult(unnamed 0: { workspace: string; id: string; }): CancelablePromise<any>

get completed job result

getCompletedJobResultMaybe(unnamed 0: { workspace: string; id: string; getStarted?: boolean; }): CancelablePromise<{ completed: boolean; result: any; success?: boolean; started?: boolean; }>

get completed job result if job is completed

getDbClock(): CancelablePromise<number>

get db clock

getFlowDebugInfo(unnamed 0: { workspace: string; id: string; }): CancelablePromise<any>

get flow debug info

getJob(unnamed 0: { workspace: string; id: string; }): CancelablePromise<Job>

get job

getJobLogs(unnamed 0: { workspace: string; id: string; }): CancelablePromise<string>

get job logs

getJobUpdates(unnamed 0: { workspace: string; id: string; running?: boolean; logOffset?: number; }): CancelablePromise<{ running?: boolean; completed?: boolean; new_logs?: string; mem_peak?: number; }>

get job updates

getQueueCount(unnamed 0: { workspace: string; }): CancelablePromise<{ database_length: number; }>

get queue count

getResumeUrls(unnamed 0: { workspace: string; id: string; resumeId: number; approver?: string; }): CancelablePromise<{ approvalPage: string; resume: string; cancel: string; }>

get resume urls given a job_id, resume_id and a nonce to resume a flow

getRootJobId(unnamed 0: { workspace: string; id: string; }): CancelablePromise<string>

get root job id

getSuspendedJobFlow(unnamed 0: { workspace: string; id: string; resumeId: number; signature: string; approver?: string; }): CancelablePromise<{ job: Job; approvers: Array<{ resume_id: number; approver: string; }>; }>

get parent flow job of suspended job

listCompletedJobs(unnamed 0: { workspace: string; orderDesc?: boolean; createdBy?: string; parentJob?: string; scriptPathExact?: string; scriptPathStart?: string; schedulePath?: string; scriptHash?: string; startedBefore?: string; startedAfter?: string; success?: boolean; jobKinds?: string; args?: string; result?: string; tag?: string; isSkipped?: boolean; isFlowStep?: boolean; }): CancelablePromise<Array<CompletedJob>>

list all completed jobs

listJobs(unnamed 0: { workspace: string; createdBy?: string; parentJob?: string; scriptPathExact?: string; scriptPathStart?: string; schedulePath?: string; scriptHash?: string; startedBefore?: string; startedAfter?: string; createdOrStartedBefore?: string; running?: boolean; scheduledForBeforeNow?: boolean; createdOrStartedAfter?: string; jobKinds?: string; args?: string; tag?: string; result?: string; isSkipped?: boolean; isFlowStep?: boolean; success?: boolean; }): CancelablePromise<Array<Job>>

list all jobs

listQueue(unnamed 0: { workspace: string; orderDesc?: boolean; createdBy?: string; parentJob?: string; scriptPathExact?: string; scriptPathStart?: string; schedulePath?: string; scriptHash?: string; startedBefore?: string; startedAfter?: string; success?: boolean; scheduledForBeforeNow?: boolean; jobKinds?: string; suspended?: boolean; running?: boolean; args?: string; result?: string; tag?: string; }): CancelablePromise<Array<QueuedJob>>

list all queued jobs

openaiSyncFlowByPath(unnamed 0: { workspace: string; path: string; requestBody: ScriptArgs; includeHeader?: string; queueLimit?: string; jobId?: string; }): CancelablePromise<any>

run flow by path and wait until completion in openai format

openaiSyncScriptByPath(unnamed 0: { workspace: string; path: string; requestBody: ScriptArgs; parentJob?: string; jobId?: string; includeHeader?: string; queueLimit?: string; }): CancelablePromise<any>

run script by path in openai format

restartFlowAtStep(unnamed 0: { workspace: string; id: string; stepId: string; branchOrIterationN: number; requestBody: ScriptArgs; scheduledFor?: string; scheduledInSecs?: number; parentJob?: string; tag?: string; jobId?: string; includeHeader?: string; invisibleToOwner?: boolean; }): CancelablePromise<string>

restart a completed flow at a given step

resultById(unnamed 0: { workspace: string; flowJobId: string; nodeId: string; }): CancelablePromise<any>

get job result by id

resumeSuspendedFlowAsOwner(unnamed 0: { workspace: string; id: string; requestBody: any; }): CancelablePromise<string>

resume a job for a suspended flow as an owner

resumeSuspendedJobGet(unnamed 0: { workspace: string; id: string; resumeId: number; signature: string; payload?: string; approver?: string; }): CancelablePromise<string>

resume a job for a suspended flow

resumeSuspendedJobPost(unnamed 0: { workspace: string; id: string; resumeId: number; signature: string; requestBody: any; approver?: string; }): CancelablePromise<string>

resume a job for a suspended flow

runFlowByPath(unnamed 0: { workspace: string; path: string; requestBody: ScriptArgs; scheduledFor?: string; scheduledInSecs?: number; parentJob?: string; tag?: string; jobId?: string; includeHeader?: string; invisibleToOwner?: boolean; }): CancelablePromise<string>

run flow by path

runFlowPreview(unnamed 0: { workspace: string; requestBody: FlowPreview; includeHeader?: string; invisibleToOwner?: boolean; jobId?: string; }): CancelablePromise<string>

run flow preview

runRawScriptDependencies(unnamed 0: { workspace: string; requestBody: { raw_scripts: Array<RawScriptForDependencies>; entrypoint: string; }; }): CancelablePromise<{ lock: string; }>

run a one-off dependencies job

runScriptByHash(unnamed 0: { workspace: string; hash: string; requestBody: any; scheduledFor?: string; scheduledInSecs?: number; parentJob?: string; tag?: string; jobId?: string; includeHeader?: string; invisibleToOwner?: boolean; }): CancelablePromise<string>

run script by hash

runScriptByPath(unnamed 0: { workspace: string; path: string; requestBody: ScriptArgs; scheduledFor?: string; scheduledInSecs?: number; parentJob?: string; tag?: string; jobId?: string; invisibleToOwner?: boolean; }): CancelablePromise<string>

run script by path

runScriptPreview(unnamed 0: { workspace: string; requestBody: Preview; includeHeader?: string; invisibleToOwner?: boolean; jobId?: string; }): CancelablePromise<string>

run script preview

runWaitResultFlowByPath(unnamed 0: { workspace: string; path: string; requestBody: ScriptArgs; includeHeader?: string; queueLimit?: string; jobId?: string; }): CancelablePromise<any>

run flow by path and wait until completion

runWaitResultScriptByPath(unnamed 0: { workspace: string; path: string; requestBody: ScriptArgs; parentJob?: string; tag?: string; jobId?: string; includeHeader?: string; queueLimit?: string; }): CancelablePromise<any>

run script by path

runWaitResultScriptByPathGet(unnamed 0: { workspace: string; path: string; parentJob?: string; tag?: string; jobId?: string; includeHeader?: string; queueLimit?: string; payload?: string; }): CancelablePromise<any>

run script by path with get