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

x/windmill/mod.ts>JobApi

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

Constructors

new
JobApi(
configuration: Configuration,
requestFactory?: JobApiRequestFactory,
responseProcessor?: JobApiResponseProcessor,
)

Properties

private
api: ObservableJobApi

Methods

cancelQueuedJob(
workspace: string,
id: string,
inlineObject18: InlineObject18,
_options?: Configuration,
): Promise<string>

cancel queued job

deleteCompletedJob(
workspace: string,
id: string,
_options?: Configuration,
): Promise<CompletedJob>

delete completed job (erase content but keep run id)

getCompletedJob(
workspace: string,
id: string,
_options?: Configuration,
): Promise<CompletedJob>

get completed job

getJob(
workspace: string,
id: string,
_options?: Configuration,
): Promise<Job>

get job

getJobUpdates(
workspace: string,
id: string,
running?: boolean,
logOffset?: number,
_options?: Configuration,
): Promise<InlineResponse2005>

get job updates

listCompletedJobs(
workspace: string,
orderDesc?: boolean,
createdBy?: string,
parentJob?: string,
scriptPathExact?: string,
scriptPathStart?: string,
scriptHash?: string,
createdBefore?: Date,
createdAfter?: Date,
success?: boolean,
jobKinds?: string,
isSkipped?: boolean,
_options?: Configuration,
): Promise<Array<CompletedJob>>

list all available completed jobs

listJobs(
workspace: string,
createdBy?: string,
parentJob?: string,
scriptPathExact?: string,
scriptPathStart?: string,
scriptHash?: string,
createdBefore?: Date,
createdAfter?: Date,
jobKinds?: string,
isSkipped?: boolean,
success?: boolean,
_options?: Configuration,
): Promise<Array<Job>>

list all available jobs

listQueue(
workspace: string,
orderDesc?: boolean,
createdBy?: string,
parentJob?: string,
scriptPathExact?: string,
scriptPathStart?: string,
scriptHash?: string,
createdBefore?: Date,
createdAfter?: Date,
success?: boolean,
jobKinds?: string,
_options?: Configuration,
): Promise<Array<QueuedJob>>

list all available queued jobs

runFlowByPath(
workspace: string,
path: string,
requestBody: { [key: string]: any; },
scheduledFor?: Date,
scheduledInSecs?: number,
parentJob?: string,
_options?: Configuration,
): Promise<string>

run flow by path

runFlowPreview(
workspace: string,
flowPreview: FlowPreview,
_options?: Configuration,
): Promise<string>

run flow preview

runScriptByHash(
workspace: string,
hash: string,
body: any,
scheduledFor?: Date,
scheduledInSecs?: number,
parentJob?: string,
_options?: Configuration,
): Promise<string>

run script by hash

runScriptByPath(
workspace: string,
path: string,
requestBody: { [key: string]: any; },
scheduledFor?: Date,
scheduledInSecs?: number,
parentJob?: string,
_options?: Configuration,
): Promise<string>

run script by path

runScriptPreview(
workspace: string,
preview: Preview,
_options?: Configuration,
): Promise<string>

run script preview

runWaitResultScriptByPath(
workspace: string,
path: string,
requestBody: { [key: string]: any; },
scheduledFor?: Date,
scheduledInSecs?: number,
parentJob?: string,
_options?: Configuration,
): Promise<any>

run script by path