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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017/* 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, cacheTtl, 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, /** * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl */ cacheTtl?: 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, 'cache_ttl': cacheTtl, '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, cacheTtl, 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, /** * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl */ cacheTtl?: 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, 'cache_ttl': cacheTtl, '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, cacheTtl, 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, /** * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl */ cacheTtl?: 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, 'cache_ttl': cacheTtl, '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, cacheTtl, 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, /** * Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl */ cacheTtl?: 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, 'cache_ttl': cacheTtl, '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, page, perPage, 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, /** * which page to return (start at 1, default 1) */ page?: number, /** * number of items to return for a given page (default 30, max 100) */ perPage?: number, /** * 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, 'page': page, 'per_page': perPage, '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, page, perPage, 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, /** * which page to return (start at 1, default 1) */ page?: number, /** * number of items to return for a given page (default 30, max 100) */ perPage?: number, /** * 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, 'page': page, 'per_page': perPage, '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, page, perPage, 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, /** * which page to return (start at 1, default 1) */ page?: number, /** * number of items to return for a given page (default 30, max 100) */ perPage?: number, /** * 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, 'page': page, 'per_page': perPage, '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 log file from object store * @returns any job log * @throws ApiError */ public static getLogFileFromStore({ workspace, path, }: { workspace: string, path: string, }): CancelablePromise<any> { return __request(OpenAPI, { method: 'GET', url: '/w/{workspace}/jobs_u/get_log_file/{path}', path: { 'workspace': workspace, 'path': path, }, }); }
/** * 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, }, }); }
}