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

x/windmill/windmill-api/types/ObjectParamAPI.ts>ObjectJobApi

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 ObjectJobApi
import { ObjectJobApi } from "https://deno.land/x/windmill@v1.38.3/windmill-api/types/ObjectParamAPI.ts";

Constructors

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

Methods

cancelQueuedJob(param: JobApiCancelQueuedJobRequest, options?: Configuration): Promise<string>

cancel queued job

cancelSuspendedJobGet(param: JobApiCancelSuspendedJobGetRequest, options?: Configuration): Promise<string>

cancel a job for a suspended flow

cancelSuspendedJobPost(param: JobApiCancelSuspendedJobPostRequest, options?: Configuration): Promise<string>

cancel a job for a suspended flow

createJobSignature(param: JobApiCreateJobSignatureRequest, options?: Configuration): Promise<string>

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

deleteCompletedJob(param: JobApiDeleteCompletedJobRequest, options?: Configuration): Promise<CompletedJob>

delete completed job (erase content but keep run id)

getCompletedJob(param: JobApiGetCompletedJobRequest, options?: Configuration): Promise<CompletedJob>

get completed job

getJob(param: JobApiGetJobRequest, options?: Configuration): Promise<Job>

get job

getJobUpdates(param: JobApiGetJobUpdatesRequest, options?: Configuration): Promise<InlineResponse2006>

get job updates

listCompletedJobs(param: JobApiListCompletedJobsRequest, options?: Configuration): Promise<Array<CompletedJob>>

list all available completed jobs

listJobs(param: JobApiListJobsRequest, options?: Configuration): Promise<Array<Job>>

list all available jobs

listQueue(param: JobApiListQueueRequest, options?: Configuration): Promise<Array<QueuedJob>>

list all available queued jobs

resumeSuspendedJobGet(param: JobApiResumeSuspendedJobGetRequest, options?: Configuration): Promise<string>

resume a job for a suspended flow

resumeSuspendedJobPost(param: JobApiResumeSuspendedJobPostRequest, options?: Configuration): Promise<string>

resume a job for a suspended flow

runFlowByPath(param: JobApiRunFlowByPathRequest, options?: Configuration): Promise<string>

run flow by path

runFlowPreview(param: JobApiRunFlowPreviewRequest, options?: Configuration): Promise<string>

run flow preview

runScriptByHash(param: JobApiRunScriptByHashRequest, options?: Configuration): Promise<string>

run script by hash

runScriptByPath(param: JobApiRunScriptByPathRequest, options?: Configuration): Promise<string>

run script by path

runScriptPreview(param: JobApiRunScriptPreviewRequest, options?: Configuration): Promise<string>

run script preview

runWaitResultScriptByPath(param: JobApiRunWaitResultScriptByPathRequest, options?: Configuration): Promise<any>

run script by path