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

x/windmill/windmill-api/index.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
import { JobService } from "https://deno.land/x/windmill@v1.52.0/windmill-api/index.ts";

Static Methods

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)

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

get completed job

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

get job

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

get job updates

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

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; scriptHash?: string; createdBefore?: string; createdAfter?: string; success?: boolean; jobKinds?: string; isSkipped?: boolean; isFlowStep?: boolean; }): CancelablePromise<Array<CompletedJob>>

list all available completed jobs

listJobs(unnamed 0: { workspace: string; createdBy?: string; parentJob?: string; scriptPathExact?: string; scriptPathStart?: string; scriptHash?: string; createdBefore?: string; createdAfter?: string; jobKinds?: string; isSkipped?: boolean; isFlowStep?: boolean; success?: boolean; }): CancelablePromise<Array<Job>>

list all available jobs

listQueue(unnamed 0: { workspace: string; orderDesc?: boolean; createdBy?: string; parentJob?: string; scriptPathExact?: string; scriptPathStart?: string; scriptHash?: string; createdBefore?: string; createdAfter?: string; success?: boolean; jobKinds?: string; }): CancelablePromise<Array<QueuedJob>>

list all available queued jobs

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

get job result by id

resumeSuspendedJobGet(unnamed 0: { workspace: string; id: string; resumeId: number; signature: 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; }): CancelablePromise<string>

run flow by path

runFlowPreview(unnamed 0: { workspace: string; requestBody: FlowPreview; }): CancelablePromise<string>

run flow preview

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

run script by hash

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

run script by path

runScriptPreview(unnamed 0: { workspace: string; requestBody: Preview; }): CancelablePromise<string>

run script preview

runWaitResultScriptByPath(unnamed 0: { workspace: string; path: string; requestBody: ScriptArgs; scheduledFor?: string; scheduledInSecs?: number; parentJob?: string; }): CancelablePromise<any>

run script by path