mirror of
https://github.com/windmill-labs/windmill.git
synced 2026-08-18 16:02:10 +00:00
Ruben Fiszel
226 lines
125 KiB
HTML
226 lines
125 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>JobService | windmill-client</title><meta name="description" content="Documentation for windmill-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">windmill-client</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">windmill-client</a></li><li><a href="JobService.html">JobService</a></li></ul><h1>Class JobService</h1></div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3734</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="JobService.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="JobService.html#cancelAll" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>All</span></a>
|
|
<a href="JobService.html#cancelPersistentQueuedJobs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Persistent<wbr/>Queued<wbr/>Jobs</span></a>
|
|
<a href="JobService.html#cancelQueuedJob" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Queued<wbr/>Job</span></a>
|
|
<a href="JobService.html#cancelSuspendedJobGet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Suspended<wbr/>Job<wbr/>Get</span></a>
|
|
<a href="JobService.html#cancelSuspendedJobPost" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Suspended<wbr/>Job<wbr/>Post</span></a>
|
|
<a href="JobService.html#createJobSignature" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Job<wbr/>Signature</span></a>
|
|
<a href="JobService.html#deleteCompletedJob" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Completed<wbr/>Job</span></a>
|
|
<a href="JobService.html#forceCancelQueuedJob" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Cancel<wbr/>Queued<wbr/>Job</span></a>
|
|
<a href="JobService.html#getCompletedCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Completed<wbr/>Count</span></a>
|
|
<a href="JobService.html#getCompletedJob" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Completed<wbr/>Job</span></a>
|
|
<a href="JobService.html#getCompletedJobResult" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Completed<wbr/>Job<wbr/>Result</span></a>
|
|
<a href="JobService.html#getCompletedJobResultMaybe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Completed<wbr/>Job<wbr/>Result<wbr/>Maybe</span></a>
|
|
<a href="JobService.html#getDbClock" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Db<wbr/>Clock</span></a>
|
|
<a href="JobService.html#getFlowDebugInfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Flow<wbr/>Debug<wbr/>Info</span></a>
|
|
<a href="JobService.html#getFlowUserState" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Flow<wbr/>User<wbr/>State</span></a>
|
|
<a href="JobService.html#getJob" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Job</span></a>
|
|
<a href="JobService.html#getJobLogs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Job<wbr/>Logs</span></a>
|
|
<a href="JobService.html#getJobUpdates" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Job<wbr/>Updates</span></a>
|
|
<a href="JobService.html#getLogFileFromStore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Log<wbr/>File<wbr/>From<wbr/>Store</span></a>
|
|
<a href="JobService.html#getQueueCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Queue<wbr/>Count</span></a>
|
|
<a href="JobService.html#getResumeUrls" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Resume<wbr/>Urls</span></a>
|
|
<a href="JobService.html#getRootJobId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Job<wbr/>Id</span></a>
|
|
<a href="JobService.html#getSuspendedJobFlow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Suspended<wbr/>Job<wbr/>Flow</span></a>
|
|
<a href="JobService.html#listCompletedJobs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Completed<wbr/>Jobs</span></a>
|
|
<a href="JobService.html#listExtendedJobs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Extended<wbr/>Jobs</span></a>
|
|
<a href="JobService.html#listJobs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Jobs</span></a>
|
|
<a href="JobService.html#listQueue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Queue</span></a>
|
|
<a href="JobService.html#openaiSyncFlowByPath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>openai<wbr/>Sync<wbr/>Flow<wbr/>By<wbr/>Path</span></a>
|
|
<a href="JobService.html#openaiSyncScriptByPath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>openai<wbr/>Sync<wbr/>Script<wbr/>By<wbr/>Path</span></a>
|
|
<a href="JobService.html#restartFlowAtStep" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restart<wbr/>Flow<wbr/>At<wbr/>Step</span></a>
|
|
<a href="JobService.html#resultById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>result<wbr/>By<wbr/>Id</span></a>
|
|
<a href="JobService.html#resumeSuspendedFlowAsOwner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resume<wbr/>Suspended<wbr/>Flow<wbr/>As<wbr/>Owner</span></a>
|
|
<a href="JobService.html#resumeSuspendedJobGet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resume<wbr/>Suspended<wbr/>Job<wbr/>Get</span></a>
|
|
<a href="JobService.html#resumeSuspendedJobPost" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resume<wbr/>Suspended<wbr/>Job<wbr/>Post</span></a>
|
|
<a href="JobService.html#runCodeWorkflowTask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Code<wbr/>Workflow<wbr/>Task</span></a>
|
|
<a href="JobService.html#runFlowByPath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Flow<wbr/>By<wbr/>Path</span></a>
|
|
<a href="JobService.html#runFlowPreview" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Flow<wbr/>Preview</span></a>
|
|
<a href="JobService.html#runRawScriptDependencies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Raw<wbr/>Script<wbr/>Dependencies</span></a>
|
|
<a href="JobService.html#runScriptByHash" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Script<wbr/>By<wbr/>Hash</span></a>
|
|
<a href="JobService.html#runScriptByPath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Script<wbr/>By<wbr/>Path</span></a>
|
|
<a href="JobService.html#runScriptPreview" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Script<wbr/>Preview</span></a>
|
|
<a href="JobService.html#runWaitResultFlowByPath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Wait<wbr/>Result<wbr/>Flow<wbr/>By<wbr/>Path</span></a>
|
|
<a href="JobService.html#runWaitResultScriptByPath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Wait<wbr/>Result<wbr/>Script<wbr/>By<wbr/>Path</span></a>
|
|
<a href="JobService.html#runWaitResultScriptByPathGet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Wait<wbr/>Result<wbr/>Script<wbr/>By<wbr/>Path<wbr/>Get</span></a>
|
|
<a href="JobService.html#setFlowUserState" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Flow<wbr/>User<wbr/>State</span></a>
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_JobService" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Job<wbr/>Service</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="JobService.html" class="tsd-signature-type tsd-kind-class">JobService</a><a href="#constructor.new_JobService" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="JobService.html" class="tsd-signature-type tsd-kind-class">JobService</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="cancelAll" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>cancel<wbr/>All</span><a href="#cancelAll" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="cancelAll.cancelAll-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">cancel<wbr/>All</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/CancelAllResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelAllResponse</a><span class="tsd-signature-symbol">></span><a href="#cancelAll.cancelAll-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>cancel all jobs</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CancelAllData.html" class="tsd-signature-type tsd-kind-type-alias">CancelAllData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/CancelAllResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelAllResponse</a><span class="tsd-signature-symbol">></span></h4><p>string uuids of canceled jobs</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4310</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="cancelPersistentQueuedJobs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>cancel<wbr/>Persistent<wbr/>Queued<wbr/>Jobs</span><a href="#cancelPersistentQueuedJobs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="cancelPersistentQueuedJobs.cancelPersistentQueuedJobs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">cancel<wbr/>Persistent<wbr/>Queued<wbr/>Jobs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#cancelPersistentQueuedJobs.cancelPersistentQueuedJobs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>cancel all queued jobs for persistent script</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CancelPersistentQueuedJobsData.html" class="tsd-signature-type tsd-kind-type-alias">CancelPersistentQueuedJobsData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string persistent job scaled down to zero</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4697</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="cancelQueuedJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>cancel<wbr/>Queued<wbr/>Job</span><a href="#cancelQueuedJob" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="cancelQueuedJob.cancelQueuedJob-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">cancel<wbr/>Queued<wbr/>Job</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#cancelQueuedJob.cancelQueuedJob-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>cancel queued job</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CancelQueuedJobData.html" class="tsd-signature-type tsd-kind-type-alias">CancelQueuedJobData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job canceled</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4675</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="cancelSuspendedJobGet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>cancel<wbr/>Suspended<wbr/>Job<wbr/>Get</span><a href="#cancelSuspendedJobGet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="cancelSuspendedJobGet.cancelSuspendedJobGet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">cancel<wbr/>Suspended<wbr/>Job<wbr/>Get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#cancelSuspendedJobGet.cancelSuspendedJobGet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>cancel a job for a suspended flow</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CancelSuspendedJobGetData.html" class="tsd-signature-type tsd-kind-type-alias">CancelSuspendedJobGetData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job canceled</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4921</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="cancelSuspendedJobPost" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>cancel<wbr/>Suspended<wbr/>Job<wbr/>Post</span><a href="#cancelSuspendedJobPost" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="cancelSuspendedJobPost.cancelSuspendedJobPost-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">cancel<wbr/>Suspended<wbr/>Job<wbr/>Post</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#cancelSuspendedJobPost.cancelSuspendedJobPost-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>cancel a job for a suspended flow</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CancelSuspendedJobPostData.html" class="tsd-signature-type tsd-kind-type-alias">CancelSuspendedJobPostData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job canceled</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4949</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createJobSignature" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create<wbr/>Job<wbr/>Signature</span><a href="#createJobSignature" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createJobSignature.createJobSignature-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Job<wbr/>Signature</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createJobSignature.createJobSignature-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>create an HMac signature given a job id and a resume id</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/CreateJobSignatureData.html" class="tsd-signature-type tsd-kind-type-alias">CreateJobSignatureData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job signature</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4742</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteCompletedJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>delete<wbr/>Completed<wbr/>Job</span><a href="#deleteCompletedJob" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteCompletedJob.deleteCompletedJob-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Completed<wbr/>Job</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/CompletedJob.html" class="tsd-signature-type tsd-kind-type-alias">CompletedJob</a><span class="tsd-signature-symbol">></span><a href="#deleteCompletedJob.deleteCompletedJob-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>delete completed job (erase content but keep run id)</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/DeleteCompletedJobData.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCompletedJobData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/CompletedJob.html" class="tsd-signature-type tsd-kind-type-alias">CompletedJob</a><span class="tsd-signature-symbol">></span></h4><p>CompletedJob job details</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4655</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="forceCancelQueuedJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>force<wbr/>Cancel<wbr/>Queued<wbr/>Job</span><a href="#forceCancelQueuedJob" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="forceCancelQueuedJob.forceCancelQueuedJob-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">force<wbr/>Cancel<wbr/>Queued<wbr/>Job</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#forceCancelQueuedJob.forceCancelQueuedJob-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>force cancel queued job</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ForceCancelQueuedJobData.html" class="tsd-signature-type tsd-kind-type-alias">ForceCancelQueuedJobData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job canceled</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4719</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getCompletedCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Completed<wbr/>Count</span><a href="#getCompletedCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getCompletedCount.getCompletedCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Completed<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetCompletedCountResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCompletedCountResponse</a><span class="tsd-signature-symbol">></span><a href="#getCompletedCount.getCompletedCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get completed count</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetCompletedCountData.html" class="tsd-signature-type tsd-kind-type-alias">GetCompletedCountData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetCompletedCountResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCompletedCountResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown completed count</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4293</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getCompletedJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Completed<wbr/>Job</span><a href="#getCompletedJob" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getCompletedJob.getCompletedJob-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Completed<wbr/>Job</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/CompletedJob.html" class="tsd-signature-type tsd-kind-type-alias">CompletedJob</a><span class="tsd-signature-symbol">></span><a href="#getCompletedJob.getCompletedJob-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get completed job</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetCompletedJobData.html" class="tsd-signature-type tsd-kind-type-alias">GetCompletedJobData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/CompletedJob.html" class="tsd-signature-type tsd-kind-type-alias">CompletedJob</a><span class="tsd-signature-symbol">></span></h4><p>CompletedJob job details</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4594</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getCompletedJobResult" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Completed<wbr/>Job<wbr/>Result</span><a href="#getCompletedJobResult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getCompletedJobResult.getCompletedJobResult-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Completed<wbr/>Job<wbr/>Result</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#getCompletedJobResult.getCompletedJobResult-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get completed job result</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetCompletedJobResultData.html" class="tsd-signature-type tsd-kind-type-alias">GetCompletedJobResultData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4613</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getCompletedJobResultMaybe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Completed<wbr/>Job<wbr/>Result<wbr/>Maybe</span><a href="#getCompletedJobResultMaybe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getCompletedJobResultMaybe.getCompletedJobResultMaybe-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Completed<wbr/>Job<wbr/>Result<wbr/>Maybe</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetCompletedJobResultMaybeResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCompletedJobResultMaybeResponse</a><span class="tsd-signature-symbol">></span><a href="#getCompletedJobResultMaybe.getCompletedJobResultMaybe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get completed job result if job is completed</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetCompletedJobResultMaybeData.html" class="tsd-signature-type tsd-kind-type-alias">GetCompletedJobResultMaybeData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetCompletedJobResultMaybeResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCompletedJobResultMaybeResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4633</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDbClock" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Db<wbr/>Clock</span><a href="#getDbClock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDbClock.getDbClock-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Db<wbr/>Clock</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#getDbClock.getDbClock-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get db clock</p>
|
|
</div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>number the timestamp of the db that can be used to compute the drift</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4455</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFlowDebugInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Flow<wbr/>Debug<wbr/>Info</span><a href="#getFlowDebugInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFlowDebugInfo.getFlowDebugInfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Flow<wbr/>Debug<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#getFlowDebugInfo.getFlowDebugInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get flow debug info</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetFlowDebugInfoData.html" class="tsd-signature-type tsd-kind-type-alias">GetFlowDebugInfoData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown flow debug info details</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4575</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFlowUserState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Flow<wbr/>User<wbr/>State</span><a href="#getFlowUserState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFlowUserState.getFlowUserState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Flow<wbr/>User<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#getFlowUserState.getFlowUserState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get flow user state at a given key</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetFlowUserStateData.html" class="tsd-signature-type tsd-kind-type-alias">GetFlowUserStateData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown flow user state updated</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4876</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Job</span><a href="#getJob" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getJob.getJob-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Job</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/Job.html" class="tsd-signature-type tsd-kind-type-alias">Job</a><span class="tsd-signature-symbol">></span><a href="#getJob.getJob-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get job</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetJobData.html" class="tsd-signature-type tsd-kind-type-alias">GetJobData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/Job.html" class="tsd-signature-type tsd-kind-type-alias">Job</a><span class="tsd-signature-symbol">></span></h4><p>Job job details</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4471</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getJobLogs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Job<wbr/>Logs</span><a href="#getJobLogs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getJobLogs.getJobLogs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Job<wbr/>Logs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#getJobLogs.getJobLogs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get job logs</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetJobLogsData.html" class="tsd-signature-type tsd-kind-type-alias">GetJobLogsData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job details</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4512</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getJobUpdates" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Job<wbr/>Updates</span><a href="#getJobUpdates" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getJobUpdates.getJobUpdates-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Job<wbr/>Updates</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetJobUpdatesResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetJobUpdatesResponse</a><span class="tsd-signature-symbol">></span><a href="#getJobUpdates.getJobUpdates-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get job updates</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetJobUpdatesData.html" class="tsd-signature-type tsd-kind-type-alias">GetJobUpdatesData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetJobUpdatesResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetJobUpdatesResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown job details</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4533</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getLogFileFromStore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Log<wbr/>File<wbr/>From<wbr/>Store</span><a href="#getLogFileFromStore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getLogFileFromStore.getLogFileFromStore-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Log<wbr/>File<wbr/>From<wbr/>Store</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#getLogFileFromStore.getLogFileFromStore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get log file from object store</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetLogFileFromStoreData.html" class="tsd-signature-type tsd-kind-type-alias">GetLogFileFromStoreData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown job log</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4556</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getQueueCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Queue<wbr/>Count</span><a href="#getQueueCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getQueueCount.getQueueCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Queue<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetQueueCountResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetQueueCountResponse</a><span class="tsd-signature-symbol">></span><a href="#getQueueCount.getQueueCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get queue count</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetQueueCountData.html" class="tsd-signature-type tsd-kind-type-alias">GetQueueCountData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetQueueCountResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetQueueCountResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown queue count</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4273</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getResumeUrls" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Resume<wbr/>Urls</span><a href="#getResumeUrls" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getResumeUrls.getResumeUrls-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Resume<wbr/>Urls</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetResumeUrlsResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetResumeUrlsResponse</a><span class="tsd-signature-symbol">></span><a href="#getResumeUrls.getResumeUrls-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get resume urls given a job_id, resume_id and a nonce to resume a flow</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetResumeUrlsData.html" class="tsd-signature-type tsd-kind-type-alias">GetResumeUrlsData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetResumeUrlsResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetResumeUrlsResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown url endpoints</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4767</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRootJobId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Root<wbr/>Job<wbr/>Id</span><a href="#getRootJobId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRootJobId.getRootJobId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Root<wbr/>Job<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#getRootJobId.getRootJobId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get root job id</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetRootJobIdData.html" class="tsd-signature-type tsd-kind-type-alias">GetRootJobIdData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string get root job id</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4493</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSuspendedJobFlow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Suspended<wbr/>Job<wbr/>Flow</span><a href="#getSuspendedJobFlow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSuspendedJobFlow.getSuspendedJobFlow-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Suspended<wbr/>Job<wbr/>Flow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetSuspendedJobFlowResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSuspendedJobFlowResponse</a><span class="tsd-signature-symbol">></span><a href="#getSuspendedJobFlow.getSuspendedJobFlow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get parent flow job of suspended job</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/GetSuspendedJobFlowData.html" class="tsd-signature-type tsd-kind-type-alias">GetSuspendedJobFlowData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/GetSuspendedJobFlowResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSuspendedJobFlowResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown parent flow details</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4978</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listCompletedJobs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Completed<wbr/>Jobs</span><a href="#listCompletedJobs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listCompletedJobs.listCompletedJobs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Completed<wbr/>Jobs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListCompletedJobsResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListCompletedJobsResponse</a><span class="tsd-signature-symbol">></span><a href="#listCompletedJobs.listCompletedJobs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list all completed jobs</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListCompletedJobsData.html" class="tsd-signature-type tsd-kind-type-alias">ListCompletedJobsData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListCompletedJobsResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListCompletedJobsResponse</a><span class="tsd-signature-symbol">></span></h4><p>CompletedJob All completed jobs</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4348</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listExtendedJobs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Extended<wbr/>Jobs</span><a href="#listExtendedJobs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listExtendedJobs.listExtendedJobs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Extended<wbr/>Jobs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ExtendedJobs.html" class="tsd-signature-type tsd-kind-type-alias">ExtendedJobs</a><span class="tsd-signature-symbol">></span><a href="#listExtendedJobs.listExtendedJobs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get intervals of job runtime concurrency</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListExtendedJobsData.html" class="tsd-signature-type tsd-kind-type-alias">ListExtendedJobsData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ExtendedJobs.html" class="tsd-signature-type tsd-kind-type-alias">ExtendedJobs</a><span class="tsd-signature-symbol">></span></h4><p>ExtendedJobs time</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:5028</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listJobs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Jobs</span><a href="#listJobs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listJobs.listJobs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Jobs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListJobsResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListJobsResponse</a><span class="tsd-signature-symbol">></span><a href="#listJobs.listJobs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list all jobs</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListJobsData.html" class="tsd-signature-type tsd-kind-type-alias">ListJobsData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListJobsResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListJobsResponse</a><span class="tsd-signature-symbol">></span></h4><p>Job All jobs</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4413</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listQueue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Queue</span><a href="#listQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="listQueue.listQueue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Queue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListQueueResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListQueueResponse</a><span class="tsd-signature-symbol">></span><a href="#listQueue.listQueue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>list all queued jobs</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ListQueueData.html" class="tsd-signature-type tsd-kind-type-alias">ListQueueData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/ListQueueResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListQueueResponse</a><span class="tsd-signature-symbol">></span></h4><p>QueuedJob All queued jobs</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4232</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="openaiSyncFlowByPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>openai<wbr/>Sync<wbr/>Flow<wbr/>By<wbr/>Path</span><a href="#openaiSyncFlowByPath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="openaiSyncFlowByPath.openaiSyncFlowByPath-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">openai<wbr/>Sync<wbr/>Flow<wbr/>By<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#openaiSyncFlowByPath.openaiSyncFlowByPath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run flow by path and wait until completion in openai format</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/OpenaiSyncFlowByPathData.html" class="tsd-signature-type tsd-kind-type-alias">OpenaiSyncFlowByPathData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown job result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3902</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="openaiSyncScriptByPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>openai<wbr/>Sync<wbr/>Script<wbr/>By<wbr/>Path</span><a href="#openaiSyncScriptByPath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="openaiSyncScriptByPath.openaiSyncScriptByPath-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">openai<wbr/>Sync<wbr/>Script<wbr/>By<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#openaiSyncScriptByPath.openaiSyncScriptByPath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run script by path in openai format</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/OpenaiSyncScriptByPathData.html" class="tsd-signature-type tsd-kind-type-alias">OpenaiSyncScriptByPathData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown job result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3789</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="restartFlowAtStep" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>restart<wbr/>Flow<wbr/>At<wbr/>Step</span><a href="#restartFlowAtStep" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="restartFlowAtStep.restartFlowAtStep-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">restart<wbr/>Flow<wbr/>At<wbr/>Step</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#restartFlowAtStep.restartFlowAtStep-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>restart a completed flow at a given step</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RestartFlowAtStepData.html" class="tsd-signature-type tsd-kind-type-alias">RestartFlowAtStepData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4034</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resultById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>result<wbr/>By<wbr/>Id</span><a href="#resultById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resultById.resultById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">result<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#resultById.resultById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>get job result by id</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ResultByIdData.html" class="tsd-signature-type tsd-kind-type-alias">ResultByIdData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown job result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3962</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resumeSuspendedFlowAsOwner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>resume<wbr/>Suspended<wbr/>Flow<wbr/>As<wbr/>Owner</span><a href="#resumeSuspendedFlowAsOwner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resumeSuspendedFlowAsOwner.resumeSuspendedFlowAsOwner-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">resume<wbr/>Suspended<wbr/>Flow<wbr/>As<wbr/>Owner</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#resumeSuspendedFlowAsOwner.resumeSuspendedFlowAsOwner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>resume a job for a suspended flow as an owner</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ResumeSuspendedFlowAsOwnerData.html" class="tsd-signature-type tsd-kind-type-alias">ResumeSuspendedFlowAsOwnerData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job resumed</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4897</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resumeSuspendedJobGet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>resume<wbr/>Suspended<wbr/>Job<wbr/>Get</span><a href="#resumeSuspendedJobGet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resumeSuspendedJobGet.resumeSuspendedJobGet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">resume<wbr/>Suspended<wbr/>Job<wbr/>Get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#resumeSuspendedJobGet.resumeSuspendedJobGet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>resume a job for a suspended flow</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ResumeSuspendedJobGetData.html" class="tsd-signature-type tsd-kind-type-alias">ResumeSuspendedJobGetData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job resumed</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4796</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resumeSuspendedJobPost" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>resume<wbr/>Suspended<wbr/>Job<wbr/>Post</span><a href="#resumeSuspendedJobPost" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resumeSuspendedJobPost.resumeSuspendedJobPost-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">resume<wbr/>Suspended<wbr/>Job<wbr/>Post</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#resumeSuspendedJobPost.resumeSuspendedJobPost-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>resume a job for a suspended flow</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/ResumeSuspendedJobPostData.html" class="tsd-signature-type tsd-kind-type-alias">ResumeSuspendedJobPostData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job resumed</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4825</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runCodeWorkflowTask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Code<wbr/>Workflow<wbr/>Task</span><a href="#runCodeWorkflowTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runCodeWorkflowTask.runCodeWorkflowTask-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Code<wbr/>Workflow<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#runCodeWorkflowTask.runCodeWorkflowTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run code-workflow task</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunCodeWorkflowTaskData.html" class="tsd-signature-type tsd-kind-type-alias">RunCodeWorkflowTaskData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4140</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runFlowByPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Flow<wbr/>By<wbr/>Path</span><a href="#runFlowByPath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runFlowByPath.runFlowByPath-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Flow<wbr/>By<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#runFlowByPath.runFlowByPath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run flow by path</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunFlowByPathData.html" class="tsd-signature-type tsd-kind-type-alias">RunFlowByPathData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3992</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runFlowPreview" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Flow<wbr/>Preview</span><a href="#runFlowPreview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runFlowPreview.runFlowPreview-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Flow<wbr/>Preview</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#runFlowPreview.runFlowPreview-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run flow preview</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunFlowPreviewData.html" class="tsd-signature-type tsd-kind-type-alias">RunFlowPreviewData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4187</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runRawScriptDependencies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Raw<wbr/>Script<wbr/>Dependencies</span><a href="#runRawScriptDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runRawScriptDependencies.runRawScriptDependencies-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Raw<wbr/>Script<wbr/>Dependencies</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/RunRawScriptDependenciesResponse.html" class="tsd-signature-type tsd-kind-type-alias">RunRawScriptDependenciesResponse</a><span class="tsd-signature-symbol">></span><a href="#runRawScriptDependencies.runRawScriptDependencies-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run a one-off dependencies job</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunRawScriptDependenciesData.html" class="tsd-signature-type tsd-kind-type-alias">RunRawScriptDependenciesData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><a href="../types/RunRawScriptDependenciesResponse.html" class="tsd-signature-type tsd-kind-type-alias">RunRawScriptDependenciesResponse</a><span class="tsd-signature-symbol">></span></h4><p>unknown dependency job result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4162</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runScriptByHash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Script<wbr/>By<wbr/>Hash</span><a href="#runScriptByHash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runScriptByHash.runScriptByHash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Script<wbr/>By<wbr/>Hash</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#runScriptByHash.runScriptByHash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run script by hash</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunScriptByHashData.html" class="tsd-signature-type tsd-kind-type-alias">RunScriptByHashData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4077</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runScriptByPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Script<wbr/>By<wbr/>Path</span><a href="#runScriptByPath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runScriptByPath.runScriptByPath-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Script<wbr/>By<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#runScriptByPath.runScriptByPath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run script by path</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunScriptByPathData.html" class="tsd-signature-type tsd-kind-type-alias">RunScriptByPathData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3751</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runScriptPreview" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Script<wbr/>Preview</span><a href="#runScriptPreview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runScriptPreview.runScriptPreview-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Script<wbr/>Preview</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#runScriptPreview.runScriptPreview-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run script preview</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunScriptPreviewData.html" class="tsd-signature-type tsd-kind-type-alias">RunScriptPreviewData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string job created</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4113</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runWaitResultFlowByPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Wait<wbr/>Result<wbr/>Flow<wbr/>By<wbr/>Path</span><a href="#runWaitResultFlowByPath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runWaitResultFlowByPath.runWaitResultFlowByPath-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Wait<wbr/>Result<wbr/>Flow<wbr/>By<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#runWaitResultFlowByPath.runWaitResultFlowByPath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run flow by path and wait until completion</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunWaitResultFlowByPathData.html" class="tsd-signature-type tsd-kind-type-alias">RunWaitResultFlowByPathData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown job result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3935</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runWaitResultScriptByPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Wait<wbr/>Result<wbr/>Script<wbr/>By<wbr/>Path</span><a href="#runWaitResultScriptByPath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runWaitResultScriptByPath.runWaitResultScriptByPath-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Wait<wbr/>Result<wbr/>Script<wbr/>By<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#runWaitResultScriptByPath.runWaitResultScriptByPath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run script by path</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunWaitResultScriptByPathData.html" class="tsd-signature-type tsd-kind-type-alias">RunWaitResultScriptByPathData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown job result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3826</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runWaitResultScriptByPathGet" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>run<wbr/>Wait<wbr/>Result<wbr/>Script<wbr/>By<wbr/>Path<wbr/>Get</span><a href="#runWaitResultScriptByPathGet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="runWaitResultScriptByPathGet.runWaitResultScriptByPathGet-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>Wait<wbr/>Result<wbr/>Script<wbr/>By<wbr/>Path<wbr/>Get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#runWaitResultScriptByPathGet.runWaitResultScriptByPathGet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>run script by path with get</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/RunWaitResultScriptByPathGetData.html" class="tsd-signature-type tsd-kind-type-alias">RunWaitResultScriptByPathGetData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><p>unknown job result</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:3867</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setFlowUserState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Flow<wbr/>User<wbr/>State</span><a href="#setFlowUserState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setFlowUserState.setFlowUserState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Flow<wbr/>User<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#setFlowUserState.setFlowUserState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>set flow user state at a given key</p>
|
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a href="../types/SetFlowUserStateData.html" class="tsd-signature-type tsd-kind-type-alias">SetFlowUserStateData</a></span><div class="tsd-comment tsd-typography"><p>The data for the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CancelablePromise.html" class="tsd-signature-type tsd-kind-class">CancelablePromise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>string flow user state updated</p>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>ApiError</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:4853</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#cancelAll" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>All</span></a><a href="#cancelPersistentQueuedJobs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Persistent<wbr/>Queued<wbr/>Jobs</span></a><a href="#cancelQueuedJob" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Queued<wbr/>Job</span></a><a href="#cancelSuspendedJobGet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Suspended<wbr/>Job<wbr/>Get</span></a><a href="#cancelSuspendedJobPost" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Suspended<wbr/>Job<wbr/>Post</span></a><a href="#createJobSignature" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Job<wbr/>Signature</span></a><a href="#deleteCompletedJob" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Completed<wbr/>Job</span></a><a href="#forceCancelQueuedJob" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Cancel<wbr/>Queued<wbr/>Job</span></a><a href="#getCompletedCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Completed<wbr/>Count</span></a><a href="#getCompletedJob" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Completed<wbr/>Job</span></a><a href="#getCompletedJobResult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Completed<wbr/>Job<wbr/>Result</span></a><a href="#getCompletedJobResultMaybe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Completed<wbr/>Job<wbr/>Result<wbr/>Maybe</span></a><a href="#getDbClock" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Db<wbr/>Clock</span></a><a href="#getFlowDebugInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Flow<wbr/>Debug<wbr/>Info</span></a><a href="#getFlowUserState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Flow<wbr/>User<wbr/>State</span></a><a href="#getJob" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Job</span></a><a href="#getJobLogs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Job<wbr/>Logs</span></a><a href="#getJobUpdates" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Job<wbr/>Updates</span></a><a href="#getLogFileFromStore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Log<wbr/>File<wbr/>From<wbr/>Store</span></a><a href="#getQueueCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Queue<wbr/>Count</span></a><a href="#getResumeUrls" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Resume<wbr/>Urls</span></a><a href="#getRootJobId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Job<wbr/>Id</span></a><a href="#getSuspendedJobFlow" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Suspended<wbr/>Job<wbr/>Flow</span></a><a href="#listCompletedJobs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Completed<wbr/>Jobs</span></a><a href="#listExtendedJobs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Extended<wbr/>Jobs</span></a><a href="#listJobs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Jobs</span></a><a href="#listQueue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Queue</span></a><a href="#openaiSyncFlowByPath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>openai<wbr/>Sync<wbr/>Flow<wbr/>By<wbr/>Path</span></a><a href="#openaiSyncScriptByPath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>openai<wbr/>Sync<wbr/>Script<wbr/>By<wbr/>Path</span></a><a href="#restartFlowAtStep" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restart<wbr/>Flow<wbr/>At<wbr/>Step</span></a><a href="#resultById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>result<wbr/>By<wbr/>Id</span></a><a href="#resumeSuspendedFlowAsOwner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resume<wbr/>Suspended<wbr/>Flow<wbr/>As<wbr/>Owner</span></a><a href="#resumeSuspendedJobGet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resume<wbr/>Suspended<wbr/>Job<wbr/>Get</span></a><a href="#resumeSuspendedJobPost" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resume<wbr/>Suspended<wbr/>Job<wbr/>Post</span></a><a href="#runCodeWorkflowTask" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Code<wbr/>Workflow<wbr/>Task</span></a><a href="#runFlowByPath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Flow<wbr/>By<wbr/>Path</span></a><a href="#runFlowPreview" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Flow<wbr/>Preview</span></a><a href="#runRawScriptDependencies" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Raw<wbr/>Script<wbr/>Dependencies</span></a><a href="#runScriptByHash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Script<wbr/>By<wbr/>Hash</span></a><a href="#runScriptByPath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Script<wbr/>By<wbr/>Path</span></a><a href="#runScriptPreview" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Script<wbr/>Preview</span></a><a href="#runWaitResultFlowByPath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Wait<wbr/>Result<wbr/>Flow<wbr/>By<wbr/>Path</span></a><a href="#runWaitResultScriptByPath" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Wait<wbr/>Result<wbr/>Script<wbr/>By<wbr/>Path</span></a><a href="#runWaitResultScriptByPathGet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Wait<wbr/>Result<wbr/>Script<wbr/>By<wbr/>Path<wbr/>Get</span></a><a href="#setFlowUserState" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Flow<wbr/>User<wbr/>State</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>windmill-client</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |