starred/windmill
1
0
Fork 0
mirror of https://github.com/windmill-labs/windmill.git synced 2026-08-18 16:02:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7c44f1296d0d101ea28d0f78e56f67ee37e33521
windmill/frontend/static/tsdocs/classes/VariableService.html
T
Ruben Fiszel 7c44f1296d add tsdocs
2024-06-21 15:59:06 +02:00

47 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VariableService | 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="VariableService.html">VariableService</a></li></ul><h1>Class VariableService</h1></div><aside class="tsd-sources"><ul><li>Defined in src/services.gen.ts:1701</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="VariableService.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="VariableService.html#createVariable" 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/>Variable</span></a>
<a href="VariableService.html#deleteVariable" 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/>Variable</span></a>
<a href="VariableService.html#encryptValue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>encrypt<wbr/>Value</span></a>
<a href="VariableService.html#existsVariable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exists<wbr/>Variable</span></a>
<a href="VariableService.html#getVariable" 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/>Variable</span></a>
<a href="VariableService.html#getVariableValue" 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/>Variable<wbr/>Value</span></a>
<a href="VariableService.html#listContextualVariables" 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/>Contextual<wbr/>Variables</span></a>
<a href="VariableService.html#listVariable" 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/>Variable</span></a>
<a href="VariableService.html#updateVariable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Variable</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_VariableService" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Variable<wbr/>Service</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="VariableService.html" class="tsd-signature-type tsd-kind-class">VariableService</a><a href="#constructor.new_VariableService" 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="VariableService.html" class="tsd-signature-type tsd-kind-class">VariableService</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="createVariable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create<wbr/>Variable</span><a href="#createVariable" 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="createVariable.createVariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Variable</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#createVariable.createVariable-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 variable</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/CreateVariableData.html" class="tsd-signature-type tsd-kind-type-alias">CreateVariableData</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>string variable 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:1711</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteVariable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>delete<wbr/>Variable</span><a href="#deleteVariable" 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="deleteVariable.deleteVariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Variable</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#deleteVariable.deleteVariable-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 variable</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/DeleteVariableData.html" class="tsd-signature-type tsd-kind-type-alias">DeleteVariableData</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>string variable deleted</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:1754</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="encryptValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>encrypt<wbr/>Value</span><a href="#encryptValue" 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="encryptValue.encryptValue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">encrypt<wbr/>Value</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#encryptValue.encryptValue-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>encrypt value</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/EncryptValueData.html" class="tsd-signature-type tsd-kind-type-alias">EncryptValueData</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>string encrypted value</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:1734</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="existsVariable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>exists<wbr/>Variable</span><a href="#existsVariable" 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="existsVariable.existsVariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exists<wbr/>Variable</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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#existsVariable.existsVariable-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>does variable exists at 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/ExistsVariableData.html" class="tsd-signature-type tsd-kind-type-alias">ExistsVariableData</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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>boolean variable</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:1846</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getVariable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Variable</span><a href="#getVariable" 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="getVariable.getVariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Variable</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">&lt;</span><a href="../types/ListableVariable.html" class="tsd-signature-type tsd-kind-type-alias">ListableVariable</a><span class="tsd-signature-symbol">&gt;</span><a href="#getVariable.getVariable-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 variable</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/GetVariableData.html" class="tsd-signature-type tsd-kind-type-alias">GetVariableData</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">&lt;</span><a href="../types/ListableVariable.html" class="tsd-signature-type tsd-kind-type-alias">ListableVariable</a><span class="tsd-signature-symbol">&gt;</span></h4><p>ListableVariable variable</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:1804</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getVariableValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Variable<wbr/>Value</span><a href="#getVariableValue" 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="getVariableValue.getVariableValue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Variable<wbr/>Value</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getVariableValue.getVariableValue-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 variable value</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/GetVariableValueData.html" class="tsd-signature-type tsd-kind-type-alias">GetVariableValueData</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>string variable</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:1827</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listContextualVariables" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Contextual<wbr/>Variables</span><a href="#listContextualVariables" 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="listContextualVariables.listContextualVariables-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Contextual<wbr/>Variables</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">&lt;</span><a href="../types/ListContextualVariablesResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListContextualVariablesResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#listContextualVariables.listContextualVariables-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 contextual variables</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/ListContextualVariablesData.html" class="tsd-signature-type tsd-kind-type-alias">ListContextualVariablesData</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">&lt;</span><a href="../types/ListContextualVariablesResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListContextualVariablesResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>ContextualVariable contextual variable list</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:1881</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="listVariable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>list<wbr/>Variable</span><a href="#listVariable" 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="listVariable.listVariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">list<wbr/>Variable</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">&lt;</span><a href="../types/ListVariableResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListVariableResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#listVariable.listVariable-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 variables</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/ListVariableData.html" class="tsd-signature-type tsd-kind-type-alias">ListVariableData</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">&lt;</span><a href="../types/ListVariableResponse.html" class="tsd-signature-type tsd-kind-type-alias">ListVariableResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>ListableVariable variable list</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:1864</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateVariable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>update<wbr/>Variable</span><a href="#updateVariable" 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="updateVariable.updateVariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Variable</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#updateVariable.updateVariable-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>update variable</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/UpdateVariableData.html" class="tsd-signature-type tsd-kind-type-alias">UpdateVariableData</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>string variable 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:1775</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="#createVariable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Variable</span></a><a href="#deleteVariable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Variable</span></a><a href="#encryptValue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>encrypt<wbr/>Value</span></a><a href="#existsVariable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exists<wbr/>Variable</span></a><a href="#getVariable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Variable</span></a><a href="#getVariableValue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Variable<wbr/>Value</span></a><a href="#listContextualVariables" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Contextual<wbr/>Variables</span></a><a href="#listVariable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Variable</span></a><a href="#updateVariable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Variable</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>
Reference in New Issue View Git Blame Copy Permalink