mirror of
https://github.com/sasjs/adapter.git
synced 2026-01-07 04:20:05 +00:00
docs(context): update docs related to getComputeContextByName function
This commit is contained in:
Yury Shkoda
@@ -118,8 +118,8 @@
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getaccesstoken" class="tsd-kind-icon">getAccessToken</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getallcontexts" class="tsd-kind-icon">getAllContexts</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getauthcode" class="tsd-kind-icon">getAuthCode</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getcomputecontextbyname" class="tsd-kind-icon">getComputeContextByName</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getconfig" class="tsd-kind-icon">getConfig</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getcontextbyname" class="tsd-kind-icon">getContextByName</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getexecutablecontexts" class="tsd-kind-icon">getExecutableContexts</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getjobsinfolder" class="tsd-kind-icon">getJobsInFolder</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#movefolder" class="tsd-kind-icon">moveFolder</a></li>
|
||||
@@ -508,8 +508,8 @@
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1479">
|
||||
SASViyaApiClient.ts:1479
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1480">
|
||||
SASViyaApiClient.ts:1480
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -897,6 +897,51 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcomputecontextbyname" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Compute<wbr>Context<wbr>ByName</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Compute<wbr>Context<wbr>ByName<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1396">
|
||||
SASViyaApiClient.ts:1396
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
||||
<div class="lead">
|
||||
<p>Returns a JSON representation of a compute context.</p>
|
||||
</div>
|
||||
</div><div class="tsd-comment tsd-typography tsd-comment-tags">
|
||||
<dl class="tsd-comment-tags"><dt>example:</dt>
|
||||
<dd><p>{ "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }</p>
|
||||
</dd></dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography tsd-comment-text">
|
||||
<p>the name of the context to return.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography tsd-comment-text">
|
||||
<p>an access token for an authorized user.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getconfig" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Config</h3>
|
||||
@@ -931,47 +976,6 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontextbyname" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Context<wbr>ByName</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Context<wbr>ByName<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1395">
|
||||
SASViyaApiClient.ts:1395
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
||||
<div class="lead">
|
||||
<p>Returns a compute context.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography tsd-comment-text">
|
||||
<p>the name of the context to return.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography tsd-comment-text">
|
||||
<p>an access token for an authorized user.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getexecutablecontexts" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Executable<wbr>Contexts</h3>
|
||||
@@ -1050,8 +1054,8 @@
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1430">
|
||||
SASViyaApiClient.ts:1430
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1431">
|
||||
SASViyaApiClient.ts:1431
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -1188,8 +1192,8 @@
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1496">
|
||||
SASViyaApiClient.ts:1496
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1497">
|
||||
SASViyaApiClient.ts:1497
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -1215,8 +1219,8 @@
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1501">
|
||||
SASViyaApiClient.ts:1501
|
||||
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1502">
|
||||
SASViyaApiClient.ts:1502
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -1294,10 +1298,10 @@
|
||||
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getauthcode" class="tsd-kind-icon">get<wbr>Auth<wbr>Code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getconfig" class="tsd-kind-icon">get<wbr>Config</a>
|
||||
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getcomputecontextbyname" class="tsd-kind-icon">get<wbr>Compute<wbr>Context<wbr>ByName</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getcontextbyname" class="tsd-kind-icon">get<wbr>Context<wbr>ByName</a>
|
||||
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getconfig" class="tsd-kind-icon">get<wbr>Config</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getexecutablecontexts" class="tsd-kind-icon">get<wbr>Executable<wbr>Contexts</a>
|
||||
|
||||
Reference in New Issue
Block a user