Module
x/windmill/windmill-api/services/JobService.ts
Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Extremely Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935/* istanbul ignore file *//* tslint:disable *//* eslint-disable */import type { CompletedJob } from '../models/CompletedJob.ts';import type { FlowPreview } from '../models/FlowPreview.ts';import type { Job } from '../models/Job.ts';import type { Preview } from '../models/Preview.ts';import type { QueuedJob } from '../models/QueuedJob.ts';import type { RawScriptForDependencies } from '../models/RawScriptForDependencies.ts';import type { ScriptArgs } from '../models/ScriptArgs.ts';import type { WorkflowStatusRecord } from '../models/WorkflowStatusRecord.ts';import type { WorkflowTask } from '../models/WorkflowTask.ts';
import type { CancelablePromise } from '../core/CancelablePromise.ts';import { OpenAPI } from '../core/OpenAPI.ts';import { request as __request } from '../core/request.ts';
export class JobService {
/** * run script by path * @returns string job created * @throws ApiError */ public static runScriptByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, tag, jobId, invisibleToOwner, }: { workspace: string, path: string, /** * script args */ requestBody: ScriptArgs, /** * when to schedule this job (leave empty for immediate run) */ scheduledFor?: string, /** * schedule the script to execute in the number of seconds starting now */ scheduledInSecs?: number, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * Override the tag to use */ tag?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, /** * make the run invisible to the the script owner (default false) */ invisibleToOwner?: boolean, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/run/p/{path}', path: { 'workspace': workspace, 'path': path, }, query: { 'scheduled_for': scheduledFor, 'scheduled_in_secs': scheduledInSecs, 'parent_job': parentJob, 'tag': tag, 'job_id': jobId, 'invisible_to_owner': invisibleToOwner, }, body: requestBody, mediaType: 'application/json', }); }
/** * run script by path in openai format * @returns any job result * @throws ApiError */ public static openaiSyncScriptByPath({ workspace, path, requestBody, parentJob, jobId, includeHeader, queueLimit, }: { workspace: string, path: string, /** * script args */ requestBody: ScriptArgs, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * The maximum size of the queue for which the request would get rejected if that job would push it above that limit * */ queueLimit?: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/openai_sync/p/{path}', path: { 'workspace': workspace, 'path': path, }, query: { 'parent_job': parentJob, 'job_id': jobId, 'include_header': includeHeader, 'queue_limit': queueLimit, }, body: requestBody, mediaType: 'application/json', }); }
/** * run script by path * @returns any job result * @throws ApiError */ public static runWaitResultScriptByPath({ workspace, path, requestBody, parentJob, tag, jobId, includeHeader, queueLimit, }: { workspace: string, path: string, /** * script args */ requestBody: ScriptArgs, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * Override the tag to use */ tag?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * The maximum size of the queue for which the request would get rejected if that job would push it above that limit * */ queueLimit?: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/run_wait_result/p/{path}', path: { 'workspace': workspace, 'path': path, }, query: { 'parent_job': parentJob, 'tag': tag, 'job_id': jobId, 'include_header': includeHeader, 'queue_limit': queueLimit, }, body: requestBody, mediaType: 'application/json', }); }
/** * run script by path with get * @returns any job result * @throws ApiError */ public static runWaitResultScriptByPathGet({ workspace, path, parentJob, tag, jobId, includeHeader, queueLimit, payload, }: { workspace: string, path: string, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * Override the tag to use */ tag?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * The maximum size of the queue for which the request would get rejected if that job would push it above that limit * */ queueLimit?: string, /** * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent * `encodeURIComponent(btoa(JSON.stringify({a: 2})))` * */ payload?: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/run_wait_result/p/{path}', path: { 'workspace': workspace, 'path': path, }, query: { 'parent_job': parentJob, 'tag': tag, 'job_id': jobId, 'include_header': includeHeader, 'queue_limit': queueLimit, 'payload': payload, }, }); }
/** * run flow by path and wait until completion in openai format * @returns any job result * @throws ApiError */ public static openaiSyncFlowByPath({ workspace, path, requestBody, includeHeader, queueLimit, jobId, }: { workspace: string, path: string, /** * script args */ requestBody: ScriptArgs, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * The maximum size of the queue for which the request would get rejected if that job would push it above that limit * */ queueLimit?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/openai_sync/f/{path}', path: { 'workspace': workspace, 'path': path, }, query: { 'include_header': includeHeader, 'queue_limit': queueLimit, 'job_id': jobId, }, body: requestBody, mediaType: 'application/json', }); }
/** * run flow by path and wait until completion * @returns any job result * @throws ApiError */ public static runWaitResultFlowByPath({ workspace, path, requestBody, includeHeader, queueLimit, jobId, }: { workspace: string, path: string, /** * script args */ requestBody: ScriptArgs, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * The maximum size of the queue for which the request would get rejected if that job would push it above that limit * */ queueLimit?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/run_wait_result/f/{path}', path: { 'workspace': workspace, 'path': path, }, query: { 'include_header': includeHeader, 'queue_limit': queueLimit, 'job_id': jobId, }, body: requestBody, mediaType: 'application/json', }); }
/** * get job result by id * @returns any job result * @throws ApiError */ public static resultById({ workspace, flowJobId, nodeId, }: { workspace: string, flowJobId: string, nodeId: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/result_by_id/{flow_job_id}/{node_id}', path: { 'workspace': workspace, 'flow_job_id': flowJobId, 'node_id': nodeId, }, }); }
/** * run flow by path * @returns string job created * @throws ApiError */ public static runFlowByPath({ workspace, path, requestBody, scheduledFor, scheduledInSecs, parentJob, tag, jobId, includeHeader, invisibleToOwner, }: { workspace: string, path: string, /** * flow args */ requestBody: ScriptArgs, /** * when to schedule this job (leave empty for immediate run) */ scheduledFor?: string, /** * schedule the script to execute in the number of seconds starting now */ scheduledInSecs?: number, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * Override the tag to use */ tag?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * make the run invisible to the the flow owner (default false) */ invisibleToOwner?: boolean, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/run/f/{path}', path: { 'workspace': workspace, 'path': path, }, query: { 'scheduled_for': scheduledFor, 'scheduled_in_secs': scheduledInSecs, 'parent_job': parentJob, 'tag': tag, 'job_id': jobId, 'include_header': includeHeader, 'invisible_to_owner': invisibleToOwner, }, body: requestBody, mediaType: 'application/json', }); }
/** * restart a completed flow at a given step * @returns string job created * @throws ApiError */ public static restartFlowAtStep({ workspace, id, stepId, branchOrIterationN, requestBody, scheduledFor, scheduledInSecs, parentJob, tag, jobId, includeHeader, invisibleToOwner, }: { workspace: string, id: string, /** * step id to restart the flow from */ stepId: string, /** * for branchall or loop, the iteration at which the flow should restart */ branchOrIterationN: number, /** * flow args */ requestBody: ScriptArgs, /** * when to schedule this job (leave empty for immediate run) */ scheduledFor?: string, /** * schedule the script to execute in the number of seconds starting now */ scheduledInSecs?: number, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * Override the tag to use */ tag?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * make the run invisible to the the flow owner (default false) */ invisibleToOwner?: boolean, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/restart/f/{id}/from/{step_id}/{branch_or_iteration_n}', path: { 'workspace': workspace, 'id': id, 'step_id': stepId, 'branch_or_iteration_n': branchOrIterationN, }, query: { 'scheduled_for': scheduledFor, 'scheduled_in_secs': scheduledInSecs, 'parent_job': parentJob, 'tag': tag, 'job_id': jobId, 'include_header': includeHeader, 'invisible_to_owner': invisibleToOwner, }, body: requestBody, mediaType: 'application/json', }); }
/** * run script by hash * @returns string job created * @throws ApiError */ public static runScriptByHash({ workspace, hash, requestBody, scheduledFor, scheduledInSecs, parentJob, tag, jobId, includeHeader, invisibleToOwner, }: { workspace: string, hash: string, /** * Partially filled args */ requestBody: any, /** * when to schedule this job (leave empty for immediate run) */ scheduledFor?: string, /** * schedule the script to execute in the number of seconds starting now */ scheduledInSecs?: number, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * Override the tag to use */ tag?: string, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * make the run invisible to the the script owner (default false) */ invisibleToOwner?: boolean, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/run/h/{hash}', path: { 'workspace': workspace, 'hash': hash, }, query: { 'scheduled_for': scheduledFor, 'scheduled_in_secs': scheduledInSecs, 'parent_job': parentJob, 'tag': tag, 'job_id': jobId, 'include_header': includeHeader, 'invisible_to_owner': invisibleToOwner, }, body: requestBody, mediaType: 'application/json', }); }
/** * run script preview * @returns string job created * @throws ApiError */ public static runScriptPreview({ workspace, requestBody, includeHeader, invisibleToOwner, jobId, }: { workspace: string, /** * preview */ requestBody: Preview, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * make the run invisible to the the script owner (default false) */ invisibleToOwner?: boolean, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/run/preview', path: { 'workspace': workspace, }, query: { 'include_header': includeHeader, 'invisible_to_owner': invisibleToOwner, 'job_id': jobId, }, body: requestBody, mediaType: 'application/json', }); }
/** * run code-workflow task * @returns string job created * @throws ApiError */ public static runCodeWorkflowTask({ workspace, jobId, entrypoint, requestBody, }: { workspace: string, jobId: string, entrypoint: string, /** * preview */ requestBody: WorkflowTask, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/workflow_as_code/{job_id}/{entrypoint}', path: { 'workspace': workspace, 'job_id': jobId, 'entrypoint': entrypoint, }, body: requestBody, mediaType: 'application/json', }); }
/** * run a one-off dependencies job * @returns any dependency job result * @throws ApiError */ public static runRawScriptDependencies({ workspace, requestBody, }: { workspace: string, /** * raw script content */ requestBody: { raw_scripts: Array<RawScriptForDependencies>; entrypoint: string; }, }): CancelablePromise<{ lock: string; }> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/run/dependencies', path: { 'workspace': workspace, }, body: requestBody, mediaType: 'application/json', }); }
/** * run flow preview * @returns string job created * @throws ApiError */ public static runFlowPreview({ workspace, requestBody, includeHeader, invisibleToOwner, jobId, }: { workspace: string, /** * preview */ requestBody: FlowPreview, /** * List of headers's keys (separated with ',') whove value are added to the args * Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key * */ includeHeader?: string, /** * make the run invisible to the the script owner (default false) */ invisibleToOwner?: boolean, /** * The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request) */ jobId?: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/run/preview_flow', path: { 'workspace': workspace, }, query: { 'include_header': includeHeader, 'invisible_to_owner': invisibleToOwner, 'job_id': jobId, }, body: requestBody, mediaType: 'application/json', }); }
/** * list all queued jobs * @returns QueuedJob All queued jobs * @throws ApiError */ public static listQueue({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, success, scheduledForBeforeNow, jobKinds, suspended, running, args, result, tag, allWorkspaces, }: { workspace: string, /** * order by desc order (default true) */ orderDesc?: boolean, /** * mask to filter exact matching user creator */ createdBy?: string, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * mask to filter exact matching path */ scriptPathExact?: string, /** * mask to filter matching starting path */ scriptPathStart?: string, /** * mask to filter by schedule path */ schedulePath?: string, /** * mask to filter exact matching path */ scriptHash?: string, /** * filter on started before (inclusive) timestamp */ startedBefore?: string, /** * filter on started after (exclusive) timestamp */ startedAfter?: string, /** * filter on successful jobs */ success?: boolean, /** * filter on jobs scheduled_for before now (hence waitinf for a worker) */ scheduledForBeforeNow?: boolean, /** * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, */ jobKinds?: string, /** * filter on suspended jobs */ suspended?: boolean, /** * filter on running jobs */ running?: boolean, /** * filter on jobs containing those args as a json subset (@> in postgres) */ args?: string, /** * filter on jobs containing those result as a json subset (@> in postgres) */ result?: string, /** * filter on jobs with a given tag/worker group */ tag?: string, /** * get jobs from all workspaces (only valid if request come from the `admins` workspace) */ allWorkspaces?: boolean, }): CancelablePromise<Array<QueuedJob>> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/queue/list', path: { 'workspace': workspace, }, query: { 'order_desc': orderDesc, 'created_by': createdBy, 'parent_job': parentJob, 'script_path_exact': scriptPathExact, 'script_path_start': scriptPathStart, 'schedule_path': schedulePath, 'script_hash': scriptHash, 'started_before': startedBefore, 'started_after': startedAfter, 'success': success, 'scheduled_for_before_now': scheduledForBeforeNow, 'job_kinds': jobKinds, 'suspended': suspended, 'running': running, 'args': args, 'result': result, 'tag': tag, 'all_workspaces': allWorkspaces, }, }); }
/** * get queue count * @returns any queue count * @throws ApiError */ public static getQueueCount({ workspace, allWorkspaces, }: { workspace: string, /** * get jobs from all workspaces (only valid if request come from the `admins` workspace) */ allWorkspaces?: boolean, }): CancelablePromise<{ database_length: number; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/queue/count', path: { 'workspace': workspace, }, query: { 'all_workspaces': allWorkspaces, }, }); }
/** * get completed count * @returns any completed count * @throws ApiError */ public static getCompletedCount({ workspace, }: { workspace: string, }): CancelablePromise<{ database_length: number; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/completed/count', path: { 'workspace': workspace, }, }); }
/** * cancel all jobs * @returns string uuids of canceled jobs * @throws ApiError */ public static cancelAll({ workspace, }: { workspace: string, }): CancelablePromise<Array<string>> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/queue/cancel_all', path: { 'workspace': workspace, }, }); }
/** * list all completed jobs * @returns CompletedJob All completed jobs * @throws ApiError */ public static listCompletedJobs({ workspace, orderDesc, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, success, jobKinds, args, result, tag, isSkipped, isFlowStep, hasNullParent, }: { workspace: string, /** * order by desc order (default true) */ orderDesc?: boolean, /** * mask to filter exact matching user creator */ createdBy?: string, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * mask to filter exact matching path */ scriptPathExact?: string, /** * mask to filter matching starting path */ scriptPathStart?: string, /** * mask to filter by schedule path */ schedulePath?: string, /** * mask to filter exact matching path */ scriptHash?: string, /** * filter on started before (inclusive) timestamp */ startedBefore?: string, /** * filter on started after (exclusive) timestamp */ startedAfter?: string, /** * filter on successful jobs */ success?: boolean, /** * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, */ jobKinds?: string, /** * filter on jobs containing those args as a json subset (@> in postgres) */ args?: string, /** * filter on jobs containing those result as a json subset (@> in postgres) */ result?: string, /** * filter on jobs with a given tag/worker group */ tag?: string, /** * is the job skipped */ isSkipped?: boolean, /** * is the job a flow step */ isFlowStep?: boolean, /** * has null parent */ hasNullParent?: boolean, }): CancelablePromise<Array<CompletedJob>> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/completed/list', path: { 'workspace': workspace, }, query: { 'order_desc': orderDesc, 'created_by': createdBy, 'parent_job': parentJob, 'script_path_exact': scriptPathExact, 'script_path_start': scriptPathStart, 'schedule_path': schedulePath, 'script_hash': scriptHash, 'started_before': startedBefore, 'started_after': startedAfter, 'success': success, 'job_kinds': jobKinds, 'args': args, 'result': result, 'tag': tag, 'is_skipped': isSkipped, 'is_flow_step': isFlowStep, 'has_null_parent': hasNullParent, }, }); }
/** * list all jobs * @returns Job All jobs * @throws ApiError */ public static listJobs({ workspace, createdBy, parentJob, scriptPathExact, scriptPathStart, schedulePath, scriptHash, startedBefore, startedAfter, createdOrStartedBefore, running, scheduledForBeforeNow, createdOrStartedAfter, jobKinds, args, tag, result, isSkipped, isFlowStep, hasNullParent, success, allWorkspaces, }: { workspace: string, /** * mask to filter exact matching user creator */ createdBy?: string, /** * The parent job that is at the origin and responsible for the execution of this script if any */ parentJob?: string, /** * mask to filter exact matching path */ scriptPathExact?: string, /** * mask to filter matching starting path */ scriptPathStart?: string, /** * mask to filter by schedule path */ schedulePath?: string, /** * mask to filter exact matching path */ scriptHash?: string, /** * filter on started before (inclusive) timestamp */ startedBefore?: string, /** * filter on started after (exclusive) timestamp */ startedAfter?: string, /** * filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp */ createdOrStartedBefore?: string, /** * filter on running jobs */ running?: boolean, /** * filter on jobs scheduled_for before now (hence waitinf for a worker) */ scheduledForBeforeNow?: boolean, /** * filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp */ createdOrStartedAfter?: string, /** * filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, */ jobKinds?: string, /** * filter on jobs containing those args as a json subset (@> in postgres) */ args?: string, /** * filter on jobs with a given tag/worker group */ tag?: string, /** * filter on jobs containing those result as a json subset (@> in postgres) */ result?: string, /** * is the job skipped */ isSkipped?: boolean, /** * is the job a flow step */ isFlowStep?: boolean, /** * has null parent */ hasNullParent?: boolean, /** * filter on successful jobs */ success?: boolean, /** * get jobs from all workspaces (only valid if request come from the `admins` workspace) */ allWorkspaces?: boolean, }): CancelablePromise<Array<Job>> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/list', path: { 'workspace': workspace, }, query: { 'created_by': createdBy, 'parent_job': parentJob, 'script_path_exact': scriptPathExact, 'script_path_start': scriptPathStart, 'schedule_path': schedulePath, 'script_hash': scriptHash, 'started_before': startedBefore, 'started_after': startedAfter, 'created_or_started_before': createdOrStartedBefore, 'running': running, 'scheduled_for_before_now': scheduledForBeforeNow, 'created_or_started_after': createdOrStartedAfter, 'job_kinds': jobKinds, 'args': args, 'tag': tag, 'result': result, 'is_skipped': isSkipped, 'is_flow_step': isFlowStep, 'has_null_parent': hasNullParent, 'success': success, 'all_workspaces': allWorkspaces, }, }); }
/** * get db clock * @returns number the timestamp of the db that can be used to compute the drift * @throws ApiError */ public static getDbClock(): CancelablePromise<number> { return __request(OpenAPI, { method: 'GET', url: '/jobs/db_clock', }); }
/** * get job * @returns Job job details * @throws ApiError */ public static getJob({ workspace, id, noLogs, }: { workspace: string, id: string, noLogs?: boolean, }): CancelablePromise<Job> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/get/{id}', path: { 'workspace': workspace, 'id': id, }, query: { 'no_logs': noLogs, }, }); }
/** * get root job id * @returns string get root job id * @throws ApiError */ public static getRootJobId({ workspace, id, }: { workspace: string, id: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/get_root_job_id/{id}', path: { 'workspace': workspace, 'id': id, }, }); }
/** * get job logs * @returns string job details * @throws ApiError */ public static getJobLogs({ workspace, id, }: { workspace: string, id: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/get_logs/{id}', path: { 'workspace': workspace, 'id': id, }, }); }
/** * get job updates * @returns any job details * @throws ApiError */ public static getJobUpdates({ workspace, id, running, logOffset, }: { workspace: string, id: string, running?: boolean, logOffset?: number, }): CancelablePromise<{ running?: boolean; completed?: boolean; new_logs?: string; log_offset?: number; mem_peak?: number; flow_status?: WorkflowStatusRecord; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/getupdate/{id}', path: { 'workspace': workspace, 'id': id, }, query: { 'running': running, 'log_offset': logOffset, }, }); }
/** * get flow debug info * @returns any flow debug info details * @throws ApiError */ public static getFlowDebugInfo({ workspace, id, }: { workspace: string, id: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/get_flow_debug_info/{id}', path: { 'workspace': workspace, 'id': id, }, }); }
/** * get completed job * @returns CompletedJob job details * @throws ApiError */ public static getCompletedJob({ workspace, id, }: { workspace: string, id: string, }): CancelablePromise<CompletedJob> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/completed/get/{id}', path: { 'workspace': workspace, 'id': id, }, }); }
/** * get completed job result * @returns any result * @throws ApiError */ public static getCompletedJobResult({ workspace, id, }: { workspace: string, id: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/completed/get_result/{id}', path: { 'workspace': workspace, 'id': id, }, }); }
/** * get completed job result if job is completed * @returns any result * @throws ApiError */ public static getCompletedJobResultMaybe({ workspace, id, getStarted, }: { workspace: string, id: string, getStarted?: boolean, }): CancelablePromise<{ completed: boolean; result: any; success?: boolean; started?: boolean; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/completed/get_result_maybe/{id}', path: { 'workspace': workspace, 'id': id, }, query: { 'get_started': getStarted, }, }); }
/** * delete completed job (erase content but keep run id) * @returns CompletedJob job details * @throws ApiError */ public static deleteCompletedJob({ workspace, id, }: { workspace: string, id: string, }): CancelablePromise<CompletedJob> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/completed/delete/{id}', path: { 'workspace': workspace, 'id': id, }, }); }
/** * cancel queued job * @returns string job canceled * @throws ApiError */ public static cancelQueuedJob({ workspace, id, requestBody, }: { workspace: string, id: string, /** * reason */ requestBody: { reason?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs_u/queue/cancel/{id}', path: { 'workspace': workspace, 'id': id, }, body: requestBody, mediaType: 'application/json', }); }
/** * cancel all queued jobs for persistent script * @returns string persistent job scaled down to zero * @throws ApiError */ public static cancelPersistentQueuedJobs({ workspace, path, requestBody, }: { workspace: string, path: string, /** * reason */ requestBody: { reason?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs_u/queue/cancel_persistent/{path}', path: { 'workspace': workspace, 'path': path, }, body: requestBody, mediaType: 'application/json', }); }
/** * force cancel queued job * @returns string job canceled * @throws ApiError */ public static forceCancelQueuedJob({ workspace, id, requestBody, }: { workspace: string, id: string, /** * reason */ requestBody: { reason?: string; }, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs_u/queue/force_cancel/{id}', path: { 'workspace': workspace, 'id': id, }, body: requestBody, mediaType: 'application/json', }); }
/** * create an HMac signature given a job id and a resume id * @returns string job signature * @throws ApiError */ public static createJobSignature({ workspace, id, resumeId, approver, }: { workspace: string, id: string, resumeId: number, approver?: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/job_signature/{id}/{resume_id}', path: { 'workspace': workspace, 'id': id, 'resume_id': resumeId, }, query: { 'approver': approver, }, }); }
/** * get resume urls given a job_id, resume_id and a nonce to resume a flow * @returns any url endpoints * @throws ApiError */ public static getResumeUrls({ workspace, id, resumeId, approver, }: { workspace: string, id: string, resumeId: number, approver?: string, }): CancelablePromise<{ approvalPage: string; resume: string; cancel: string; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/resume_urls/{id}/{resume_id}', path: { 'workspace': workspace, 'id': id, 'resume_id': resumeId, }, query: { 'approver': approver, }, }); }
/** * resume a job for a suspended flow * @returns string job resumed * @throws ApiError */ public static resumeSuspendedJobGet({ workspace, id, resumeId, signature, payload, approver, }: { workspace: string, id: string, resumeId: number, signature: string, /** * The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent * `encodeURIComponent(btoa(JSON.stringify({a: 2})))` * */ payload?: string, approver?: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}', path: { 'workspace': workspace, 'id': id, 'resume_id': resumeId, 'signature': signature, }, query: { 'payload': payload, 'approver': approver, }, }); }
/** * resume a job for a suspended flow * @returns string job resumed * @throws ApiError */ public static resumeSuspendedJobPost({ workspace, id, resumeId, signature, requestBody, approver, }: { workspace: string, id: string, resumeId: number, signature: string, requestBody: any, approver?: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}', path: { 'workspace': workspace, 'id': id, 'resume_id': resumeId, 'signature': signature, }, query: { 'approver': approver, }, body: requestBody, mediaType: 'application/json', }); }
/** * set flow user state at a given key * @returns string flow user state updated * @throws ApiError */ public static setFlowUserState({ workspace, id, key, requestBody, }: { workspace: string, id: string, key: string, /** * new value */ requestBody: any, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/flow/user_states/{id}/{key}', path: { 'workspace': workspace, 'id': id, 'key': key, }, body: requestBody, mediaType: 'application/json', }); }
/** * get flow user state at a given key * @returns any flow user state updated * @throws ApiError */ public static getFlowUserState({ workspace, id, key, }: { workspace: string, id: string, key: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs/flow/user_states/{id}/{key}', path: { 'workspace': workspace, 'id': id, 'key': key, }, }); }
/** * resume a job for a suspended flow as an owner * @returns string job resumed * @throws ApiError */ public static resumeSuspendedFlowAsOwner({ workspace, id, requestBody, }: { workspace: string, id: string, requestBody: any, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs/flow/resume/{id}', path: { 'workspace': workspace, 'id': id, }, body: requestBody, mediaType: 'application/json', }); }
/** * cancel a job for a suspended flow * @returns string job canceled * @throws ApiError */ public static cancelSuspendedJobGet({ workspace, id, resumeId, signature, approver, }: { workspace: string, id: string, resumeId: number, signature: string, approver?: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}', path: { 'workspace': workspace, 'id': id, 'resume_id': resumeId, 'signature': signature, }, query: { 'approver': approver, }, }); }
/** * cancel a job for a suspended flow * @returns string job canceled * @throws ApiError */ public static cancelSuspendedJobPost({ workspace, id, resumeId, signature, requestBody, approver, }: { workspace: string, id: string, resumeId: number, signature: string, requestBody: any, approver?: string, }): CancelablePromise<string> { return __request(OpenAPI, { method: 'POST', url: '/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}', path: { 'workspace': workspace, 'id': id, 'resume_id': resumeId, 'signature': signature, }, query: { 'approver': approver, }, body: requestBody, mediaType: 'application/json', }); }
/** * get parent flow job of suspended job * @returns any parent flow details * @throws ApiError */ public static getSuspendedJobFlow({ workspace, id, resumeId, signature, approver, }: { workspace: string, id: string, resumeId: number, signature: string, approver?: string, }): CancelablePromise<{ job: Job; approvers: Array<{ resume_id: number; approver: string; }>; }> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/get_flow/{id}/{resume_id}/{signature}', path: { 'workspace': workspace, 'id': id, 'resume_id': resumeId, 'signature': signature, }, query: { 'approver': approver, }, }); }
}