mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 79efe1be29 to master with MkDocs 1.4.0 and mike 1.1.2
This commit is contained in:
GitHub Action committed
1 parent
e79363c0dc
commit
21b728087b
62 files changed
+4049
-3206
No files matched your search
@@ -918,7 +918,7 @@
|
||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>IpcRegistrar.__@IpcPrefix@74299</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@74415</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code><<code>LensExtensionDependencies</code>></p>
|
||||
|
||||
@@ -1069,12 +1069,12 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@29323</p>
|
||||
<p>LensExtension.__@Disposers@30074</p>
|
||||
<hr />
|
||||
<h3 id="lensextensiondependencies">[lensExtensionDependencies]<a class="headerlink" href="#lensextensiondependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[lensExtensionDependencies]</strong>: <code>LensMainExtensionDependencies</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@lensExtensionDependencies@29326</p>
|
||||
<p>LensExtension.__@lensExtensionDependencies@30077</p>
|
||||
<hr />
|
||||
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>appMenus</strong>: <code>MenuRegistration</code>[] = <code>[]</code></p>
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1083,7 +1083,7 @@
|
||||
<p>React.Component<MenuItemProps\>.constructor</p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="context">context<a class="headerlink" href="#context" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>context</strong>: <a href="../Renderer.Component.Menu/"><code>Menu</code></a></p>
|
||||
<p>• <strong>context</strong>: <a href="../../interfaces/Renderer.Component.MenuContextValue/"><code>MenuContextValue</code></a></p>
|
||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@@ -1110,7 +1110,7 @@
|
||||
<p>React.Component.state</p>
|
||||
<hr />
|
||||
<h3 id="contexttype">contextType<a class="headerlink" href="#contexttype" title="Permanent link">#</a></h3>
|
||||
<p>▪ <code>Static</code> <strong>contextType</strong>: <code>Context</code><<code>null</code> | <a href="../Renderer.Component.Menu/"><code>Menu</code></a>> = <code>MenuContext</code></p>
|
||||
<p>▪ <code>Static</code> <strong>contextType</strong>: <code>Context</code><<code>null</code> | <a href="../../interfaces/Renderer.Component.MenuContextValue/"><code>MenuContextValue</code></a>> = <code>MenuContext</code></p>
|
||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
|
||||
@@ -918,7 +918,7 @@
|
||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>IpcRegistrar.__@IpcPrefix@74299</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@74415</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code><<code>LensExtensionDependencies</code>></p>
|
||||
|
||||
@@ -2200,7 +2200,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2256,7 +2256,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2260,7 +2260,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -944,6 +944,20 @@
|
||||
delete
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlforlisting" class="md-nav__link">
|
||||
formatUrlForListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlfornotlisting" class="md-nav__link">
|
||||
formatUrlForNotListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1123,6 +1137,8 @@
|
||||
<li><a href="./#checkpreferredversion">checkPreferredVersion</a></li>
|
||||
<li><a href="./#create">create</a></li>
|
||||
<li><a href="./#delete">delete</a></li>
|
||||
<li><a href="./#formaturlforlisting">formatUrlForListing</a></li>
|
||||
<li><a href="./#formaturlfornotlisting">formatUrlForNotListing</a></li>
|
||||
<li><a href="./#get">get</a></li>
|
||||
<li><a href="./#getreplicas">getReplicas</a></li>
|
||||
<li><a href="./#getresourceversion">getResourceVersion</a></li>
|
||||
@@ -1299,9 +1315,61 @@
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#delete">delete</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlforlisting">formatUrlForListing<a class="headerlink" href="#formaturlforlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForListing</strong>(<code>namespace</code>): <code>string</code></p>
|
||||
<p>This method differs from <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> because this treats <code>""</code> as "all namespaces"</p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The namespace to list in or <code>""</code> for all namespaces</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlforlisting">formatUrlForListing</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlfornotlisting">formatUrlForNotListing<a class="headerlink" href="#formaturlfornotlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForNotListing</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p>Format a URL pathname and query for acting upon a specific resource.</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlfornotlisting">formatUrlForNotListing</a></p>
|
||||
<hr />
|
||||
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>get</strong>(<code>desc</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1320,65 +1388,13 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#get">get</a></p>
|
||||
<hr />
|
||||
<h3 id="getreplicas">getReplicas<a class="headerlink" href="#getreplicas" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getReplicas</strong>(<code>params</code>): <code>Promise</code><<code>number</code>></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>params</code></td>
|
||||
<td align="left"><code>Object</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params.name</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params.namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>number</code>></p>
|
||||
<hr />
|
||||
<h3 id="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getResourceVersion</strong>(<code>namespace?</code>): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="getscaleapiurl">getScaleApiUrl<a class="headerlink" href="#getscaleapiurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>getScaleApiUrl</strong>(<code>params</code>): <code>string</code></p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1403,42 +1419,16 @@
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<p><code>Promise</code><<code>number</code>></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h3 id="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getResourceVersion</strong>(<code>namespace?</code>): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
@@ -1448,173 +1438,16 @@
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
<td align="left"><code>{}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getwatchurl">getWatchUrl</a></p>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="list">list<a class="headerlink" href="#list" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>list</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]></p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>KubeApiListOptions</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#list">list</a></p>
|
||||
<hr />
|
||||
<h3 id="modifywatchevent">modifyWatchEvent<a class="headerlink" href="#modifywatchevent" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>modifyWatchEvent</strong>(<code>event</code>): <code>void</code></p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>event</code></td>
|
||||
<td align="left"><code>IKubeWatchEvent</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#modifywatchevent">modifyWatchEvent</a></p>
|
||||
<hr />
|
||||
<h3 id="normalizequery">normalizeQuery<a class="headerlink" href="#normalizequery" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>normalizeQuery</strong>(<code>query?</code>): <code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#normalizequery">normalizeQuery</a></p>
|
||||
<hr />
|
||||
<h3 id="parseresponse">parseResponse<a class="headerlink" href="#parseresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseResponse</strong>(<code>data</code>, <code>namespace?</code>): <code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]</p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>unknown</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>namespace?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#parseresponse">parseResponse</a></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code> | <code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>KubeApiPatchType</code></td>
|
||||
<td align="left"><code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<hr />
|
||||
<h3 id="refreshresourceversion">refreshResourceVersion<a class="headerlink" href="#refreshresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>refreshResourceVersion</strong>(<code>params?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>KubeApiListOptions</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]></p>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#refreshresourceversion">refreshResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="restart">restart<a class="headerlink" href="#restart" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>restart</strong>(<code>params</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<h3 id="getscaleapiurl">getScaleApiUrl<a class="headerlink" href="#getscaleapiurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>getScaleApiUrl</strong>(<code>params</code>): <code>string</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1637,12 +1470,322 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> instead</p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getwatchurl">getWatchUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="list">list<a class="headerlink" href="#list" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>list</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>KubeApiListOptions</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]></p>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#list">list</a></p>
|
||||
<hr />
|
||||
<h3 id="modifywatchevent">modifyWatchEvent<a class="headerlink" href="#modifywatchevent" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>modifyWatchEvent</strong>(<code>event</code>): <code>void</code></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>event</code></td>
|
||||
<td align="left"><code>IKubeWatchEvent</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#modifywatchevent">modifyWatchEvent</a></p>
|
||||
<hr />
|
||||
<h3 id="normalizequery">normalizeQuery<a class="headerlink" href="#normalizequery" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>normalizeQuery</strong>(<code>query?</code>): <code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#normalizequery">normalizeQuery</a></p>
|
||||
<hr />
|
||||
<h3 id="parseresponse">parseResponse<a class="headerlink" href="#parseresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseResponse</strong>(<code>data</code>, <code>namespace?</code>): <code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]</p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>unknown</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>namespace?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]</p>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#parseresponse">parseResponse</a></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"merge"</code> | <code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="parameters_17">Parameters<a class="headerlink" href="#parameters_17" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"json"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="parameters_18">Parameters<a class="headerlink" href="#parameters_18" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code> | <code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>KubeApiPatchType</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<hr />
|
||||
<h3 id="refreshresourceversion">refreshResourceVersion<a class="headerlink" href="#refreshresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>refreshResourceVersion</strong>(<code>params?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]></p>
|
||||
<h4 id="parameters_19">Parameters<a class="headerlink" href="#parameters_19" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>KubeApiListOptions</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>[]></p>
|
||||
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#refreshresourceversion">refreshResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="restart">restart<a class="headerlink" href="#restart" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>restart</strong>(<code>params</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<h4 id="parameters_20">Parameters<a class="headerlink" href="#parameters_20" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>params</code></td>
|
||||
<td align="left"><code>Object</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params.name</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params.namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<hr />
|
||||
<h3 id="scale">scale<a class="headerlink" href="#scale" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>scale</strong>(<code>params</code>, <code>replicas</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_21">Parameters<a class="headerlink" href="#parameters_21" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1669,12 +1812,12 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<hr />
|
||||
<h3 id="setresourceversion">setResourceVersion<a class="headerlink" href="#setresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>setResourceVersion</strong>(<code>namespace?</code>, <code>newVersion</code>): <code>void</code></p>
|
||||
<h4 id="parameters_17">Parameters<a class="headerlink" href="#parameters_17" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_22">Parameters<a class="headerlink" href="#parameters_22" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1696,14 +1839,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#setresourceversion">setResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>update</strong>(<code>__namedParameters</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="parameters_18">Parameters<a class="headerlink" href="#parameters_18" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_23">Parameters<a class="headerlink" href="#parameters_23" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1722,14 +1865,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#update">update</a></p>
|
||||
<hr />
|
||||
<h3 id="watch">watch<a class="headerlink" href="#watch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>watch</strong>(<code>opts?</code>): () => <code>void</code></p>
|
||||
<h4 id="parameters_19">Parameters<a class="headerlink" href="#parameters_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_24">Parameters<a class="headerlink" href="#parameters_24" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1739,17 +1882,17 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>opts</code></td>
|
||||
<td align="left"><code>opts?</code></td>
|
||||
<td align="left"><code>KubeApiWatchOptions</code><<a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a>, <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#namespacescopedmetadata"><code>NamespaceScopedMetadata</code></a>, <code>DeploymentStatus</code>, <code>DeploymentSpec</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||
<p><code>fn</code></p>
|
||||
<p>▸ (): <code>void</code></p>
|
||||
<h5 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h5>
|
||||
<h5 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h5>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#watch">watch</a></p>
|
||||
|
||||
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -944,6 +944,20 @@
|
||||
delete
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlforlisting" class="md-nav__link">
|
||||
formatUrlForListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlfornotlisting" class="md-nav__link">
|
||||
formatUrlForNotListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1095,6 +1109,8 @@
|
||||
<li><a href="./#checkpreferredversion">checkPreferredVersion</a></li>
|
||||
<li><a href="./#create">create</a></li>
|
||||
<li><a href="./#delete">delete</a></li>
|
||||
<li><a href="./#formaturlforlisting">formatUrlForListing</a></li>
|
||||
<li><a href="./#formaturlfornotlisting">formatUrlForNotListing</a></li>
|
||||
<li><a href="./#get">get</a></li>
|
||||
<li><a href="./#getresourceversion">getResourceVersion</a></li>
|
||||
<li><a href="./#geturl">getUrl</a></li>
|
||||
@@ -1267,9 +1283,61 @@
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#delete">delete</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlforlisting">formatUrlForListing<a class="headerlink" href="#formaturlforlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForListing</strong>(<code>namespace</code>): <code>string</code></p>
|
||||
<p>This method differs from <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> because this treats <code>""</code> as "all namespaces"</p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The namespace to list in or <code>""</code> for all namespaces</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlforlisting">formatUrlForListing</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlfornotlisting">formatUrlForNotListing<a class="headerlink" href="#formaturlfornotlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForNotListing</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p>Format a URL pathname and query for acting upon a specific resource.</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlfornotlisting">formatUrlForNotListing</a></p>
|
||||
<hr />
|
||||
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>get</strong>(<code>desc</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1288,63 +1356,13 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#get">get</a></p>
|
||||
<hr />
|
||||
<h3 id="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getResourceVersion</strong>(<code>namespace?</code>): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1360,21 +1378,70 @@
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
<td align="left"><code>{}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> instead</p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getwatchurl">getWatchUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="list">list<a class="headerlink" href="#list" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>list</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>[]></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1393,14 +1460,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>[]></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#list">list</a></p>
|
||||
<hr />
|
||||
<h3 id="modifywatchevent">modifyWatchEvent<a class="headerlink" href="#modifywatchevent" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>modifyWatchEvent</strong>(<code>event</code>): <code>void</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1415,14 +1482,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#modifywatchevent">modifyWatchEvent</a></p>
|
||||
<hr />
|
||||
<h3 id="normalizequery">normalizeQuery<a class="headerlink" href="#normalizequery" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>normalizeQuery</strong>(<code>query?</code>): <code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1437,14 +1504,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#normalizequery">normalizeQuery</a></p>
|
||||
<hr />
|
||||
<h3 id="parseresponse">parseResponse<a class="headerlink" href="#parseresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseResponse</strong>(<code>data</code>, <code>namespace?</code>): <code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>[]</p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1463,48 +1530,124 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>[]</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#parseresponse">parseResponse</a></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"merge"</code> | <code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"json"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code> | <code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>KubeApiPatchType</code></td>
|
||||
<td align="left"><code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<hr />
|
||||
<h3 id="refreshresourceversion">refreshResourceVersion<a class="headerlink" href="#refreshresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>refreshResourceVersion</strong>(<code>params?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>[]></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_17">Parameters<a class="headerlink" href="#parameters_17" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1519,14 +1662,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>[]></p>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#refreshresourceversion">refreshResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="setresourceversion">setResourceVersion<a class="headerlink" href="#setresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>setResourceVersion</strong>(<code>namespace?</code>, <code>newVersion</code>): <code>void</code></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_18">Parameters<a class="headerlink" href="#parameters_18" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1548,14 +1691,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#setresourceversion">setResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>update</strong>(<code>__namedParameters</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_19">Parameters<a class="headerlink" href="#parameters_19" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1574,14 +1717,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#update">update</a></p>
|
||||
<hr />
|
||||
<h3 id="watch">watch<a class="headerlink" href="#watch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>watch</strong>(<code>opts?</code>): () => <code>void</code></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_20">Parameters<a class="headerlink" href="#parameters_20" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1591,17 +1734,17 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>opts</code></td>
|
||||
<td align="left"><code>opts?</code></td>
|
||||
<td align="left"><code>KubeApiWatchOptions</code><<a href="../Renderer.K8sApi.Ingress/"><code>Ingress</code></a>, <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#namespacescopedmetadata"><code>NamespaceScopedMetadata</code></a>, <code>IngressStatus</code>, <code>IngressSpec</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p><code>fn</code></p>
|
||||
<p>▸ (): <code>void</code></p>
|
||||
<h5 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h5>
|
||||
<h5 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h5>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#watch">watch</a></p>
|
||||
|
||||
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2292,7 +2292,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -951,6 +951,20 @@
|
||||
delete
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlforlisting" class="md-nav__link">
|
||||
formatUrlForListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlfornotlisting" class="md-nav__link">
|
||||
formatUrlForNotListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1125,6 +1139,8 @@
|
||||
<li><a href="./#checkpreferredversion">checkPreferredVersion</a></li>
|
||||
<li><a href="./#create">create</a></li>
|
||||
<li><a href="./#delete">delete</a></li>
|
||||
<li><a href="./#formaturlforlisting">formatUrlForListing</a></li>
|
||||
<li><a href="./#formaturlfornotlisting">formatUrlForNotListing</a></li>
|
||||
<li><a href="./#get">get</a></li>
|
||||
<li><a href="./#getresourceversion">getResourceVersion</a></li>
|
||||
<li><a href="./#geturl">getUrl</a></li>
|
||||
@@ -1276,9 +1292,57 @@
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<hr />
|
||||
<h3 id="formaturlforlisting">formatUrlForListing<a class="headerlink" href="#formaturlforlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForListing</strong>(<code>namespace</code>): <code>string</code></p>
|
||||
<p>This method differs from <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> because this treats <code>""</code> as "all namespaces"</p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The namespace to list in or <code>""</code> for all namespaces</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="formaturlfornotlisting">formatUrlForNotListing<a class="headerlink" href="#formaturlfornotlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForNotListing</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p>Format a URL pathname and query for acting upon a specific resource.</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>get</strong>(<code>desc</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1297,57 +1361,11 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<hr />
|
||||
<h3 id="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getResourceVersion</strong>(<code>namespace?</code>): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1363,19 +1381,64 @@
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
<td align="left"><code>{}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> instead</p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="list">list<a class="headerlink" href="#list" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>list</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <code>Object</code>[]></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1394,12 +1457,12 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>Object</code>[]></p>
|
||||
<hr />
|
||||
<h3 id="modifywatchevent">modifyWatchEvent<a class="headerlink" href="#modifywatchevent" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>modifyWatchEvent</strong>(<code>event</code>): <code>void</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1414,12 +1477,12 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<hr />
|
||||
<h3 id="normalizequery">normalizeQuery<a class="headerlink" href="#normalizequery" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>normalizeQuery</strong>(<code>query?</code>): <code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1434,12 +1497,12 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<hr />
|
||||
<h3 id="parseresponse">parseResponse<a class="headerlink" href="#parseresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseResponse</strong>(<code>data</code>, <code>namespace?</code>): <code>null</code> | <code>Object</code> | <code>Object</code>[]</p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1458,44 +1521,114 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>null</code> | <code>Object</code> | <code>Object</code>[]</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy?</code>): <code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialDeep</code><<code>Object</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialDeep</code><<code>Object</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"merge"</code> | <code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"json"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code> | <code>PartialDeep</code><<code>Object</code>></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>KubeApiPatchType</code></td>
|
||||
<td align="left"><code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<hr />
|
||||
<h3 id="refreshresourceversion">refreshResourceVersion<a class="headerlink" href="#refreshresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>refreshResourceVersion</strong>(<code>params?</code>): <code>Promise</code><<code>null</code> | <code>Object</code>[]></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_17">Parameters<a class="headerlink" href="#parameters_17" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1510,12 +1643,12 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>Object</code>[]></p>
|
||||
<hr />
|
||||
<h3 id="setresourceversion">setResourceVersion<a class="headerlink" href="#setresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>setResourceVersion</strong>(<code>namespace?</code>, <code>newVersion</code>): <code>void</code></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_18">Parameters<a class="headerlink" href="#parameters_18" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1537,12 +1670,12 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<hr />
|
||||
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>update</strong>(<code>__namedParameters</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_19">Parameters<a class="headerlink" href="#parameters_19" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1561,12 +1694,12 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>Object</code>></p>
|
||||
<hr />
|
||||
<h3 id="watch">watch<a class="headerlink" href="#watch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>watch</strong>(<code>opts?</code>): () => <code>void</code></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_20">Parameters<a class="headerlink" href="#parameters_20" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1576,15 +1709,15 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>opts</code></td>
|
||||
<td align="left"><code>opts?</code></td>
|
||||
<td align="left"><code>KubeApiWatchOptions</code><<code>Object</code>, <code>Data</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p><code>fn</code></p>
|
||||
<p>▸ (): <code>void</code></p>
|
||||
<h5 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h5>
|
||||
<h5 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h5>
|
||||
<p><code>void</code></p>
|
||||
|
||||
|
||||
|
||||
@@ -785,6 +785,13 @@
|
||||
config
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dependencies" class="md-nav__link">
|
||||
dependencies
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -903,13 +910,6 @@
|
||||
writeLog
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#forcluster" class="md-nav__link">
|
||||
forCluster
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -946,6 +946,7 @@
|
||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#config">config</a></li>
|
||||
<li><a href="./#dependencies">dependencies</a></li>
|
||||
<li><a href="./#ondata">onData</a></li>
|
||||
<li><a href="./#onerror">onError</a></li>
|
||||
<li><a href="./#reqinit">reqInit</a></li>
|
||||
@@ -964,11 +965,10 @@
|
||||
<li><a href="./#put">put</a></li>
|
||||
<li><a href="./#request">request</a></li>
|
||||
<li><a href="./#writelog">writeLog</a></li>
|
||||
<li><a href="./#forcluster">forCluster</a></li>
|
||||
</ul>
|
||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>new KubeJsonApi</strong>(<code>config</code>, <code>reqInit?</code>)</p>
|
||||
<p>• <strong>new KubeJsonApi</strong>(<code>dependencies</code>, <code>config</code>, <code>reqInit?</code>)</p>
|
||||
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -979,6 +979,10 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>dependencies</code></td>
|
||||
<td align="left"><code>JsonApiDependencies</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>config</code></td>
|
||||
<td align="left"><code>JsonApiConfig</code></td>
|
||||
</tr>
|
||||
@@ -996,24 +1000,29 @@
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.config</p>
|
||||
<hr />
|
||||
<h3 id="dependencies">dependencies<a class="headerlink" href="#dependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>dependencies</strong>: <code>JsonApiDependencies</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.dependencies</p>
|
||||
<hr />
|
||||
<h3 id="ondata">onData<a class="headerlink" href="#ondata" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>onData</strong>: <code>EventEmitter</code><[<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>, <code>Response</code>]></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.onData</p>
|
||||
<hr />
|
||||
<h3 id="onerror">onError<a class="headerlink" href="#onerror" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>onError</strong>: <code>EventEmitter</code><[<code>JsonApiErrorParsed</code>, <code>Response</code>]></p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.onError</p>
|
||||
<hr />
|
||||
<h3 id="reqinit">reqInit<a class="headerlink" href="#reqinit" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>reqInit</strong>: <code>Defaulted</code><<code>RequestInit</code>, <code>"headers"</code>></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.reqInit</p>
|
||||
<hr />
|
||||
<h3 id="configdefault">configDefault<a class="headerlink" href="#configdefault" title="Permanent link">#</a></h3>
|
||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>configDefault</strong>: <code>Partial</code><<code>JsonApiConfig</code>></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.configDefault</p>
|
||||
<hr />
|
||||
<h3 id="reqinitdefault">reqInitDefault<a class="headerlink" href="#reqinitdefault" title="Permanent link">#</a></h3>
|
||||
@@ -1037,7 +1046,7 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.reqInitDefault</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="del">del<a class="headerlink" href="#del" title="Permanent link">#</a></h3>
|
||||
@@ -1086,7 +1095,7 @@
|
||||
</table>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.del</p>
|
||||
<hr />
|
||||
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
|
||||
@@ -1135,7 +1144,7 @@
|
||||
</table>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.get</p>
|
||||
<hr />
|
||||
<h3 id="getresponse">getResponse<a class="headerlink" href="#getresponse" title="Permanent link">#</a></h3>
|
||||
@@ -1178,7 +1187,7 @@
|
||||
</table>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>Response</code>></p>
|
||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.getResponse</p>
|
||||
<hr />
|
||||
<h3 id="parseerror">parseError<a class="headerlink" href="#parseerror" title="Permanent link">#</a></h3>
|
||||
@@ -1243,7 +1252,7 @@
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.parseResponse</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
@@ -1292,7 +1301,7 @@
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.patch</p>
|
||||
<hr />
|
||||
<h3 id="post">post<a class="headerlink" href="#post" title="Permanent link">#</a></h3>
|
||||
@@ -1341,7 +1350,7 @@
|
||||
</table>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.post</p>
|
||||
<hr />
|
||||
<h3 id="put">put<a class="headerlink" href="#put" title="Permanent link">#</a></h3>
|
||||
@@ -1390,7 +1399,7 @@
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.put</p>
|
||||
<hr />
|
||||
<h3 id="request">request<a class="headerlink" href="#request" title="Permanent link">#</a></h3>
|
||||
@@ -1439,7 +1448,7 @@
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.request</p>
|
||||
<hr />
|
||||
<h3 id="writelog">writeLog<a class="headerlink" href="#writelog" title="Permanent link">#</a></h3>
|
||||
@@ -1461,28 +1470,8 @@
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.writeLog</p>
|
||||
<hr />
|
||||
<h3 id="forcluster">forCluster<a class="headerlink" href="#forcluster" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>forCluster</strong>(<code>clusterId</code>): <a href="./"><code>KubeJsonApi</code></a></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>clusterId</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><a href="./"><code>KubeJsonApi</code></a></p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1521,7 +1521,7 @@
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Generator</code><<code>K</code>, <code>void</code>, <code>undefined</code>></p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>ItemStore.__@iterator@524</p>
|
||||
<p>ItemStore.__@iterator@476</p>
|
||||
<hr />
|
||||
<h3 id="bindwatcheventsupdater">bindWatchEventsUpdater<a class="headerlink" href="#bindwatcheventsupdater" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>bindWatchEventsUpdater</strong>(<code>delay?</code>): <code>void</code></p>
|
||||
@@ -2227,7 +2227,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2441,7 +2441,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -944,6 +944,20 @@
|
||||
delete
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlforlisting" class="md-nav__link">
|
||||
formatUrlForListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlfornotlisting" class="md-nav__link">
|
||||
formatUrlForNotListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1095,6 +1109,8 @@
|
||||
<li><a href="./#checkpreferredversion">checkPreferredVersion</a></li>
|
||||
<li><a href="./#create">create</a></li>
|
||||
<li><a href="./#delete">delete</a></li>
|
||||
<li><a href="./#formaturlforlisting">formatUrlForListing</a></li>
|
||||
<li><a href="./#formaturlfornotlisting">formatUrlForNotListing</a></li>
|
||||
<li><a href="./#get">get</a></li>
|
||||
<li><a href="./#getresourceversion">getResourceVersion</a></li>
|
||||
<li><a href="./#geturl">getUrl</a></li>
|
||||
@@ -1267,9 +1283,61 @@
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#delete">delete</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlforlisting">formatUrlForListing<a class="headerlink" href="#formaturlforlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForListing</strong>(<code>namespace</code>): <code>string</code></p>
|
||||
<p>This method differs from <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> because this treats <code>""</code> as "all namespaces"</p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The namespace to list in or <code>""</code> for all namespaces</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlforlisting">formatUrlForListing</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlfornotlisting">formatUrlForNotListing<a class="headerlink" href="#formaturlfornotlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForNotListing</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p>Format a URL pathname and query for acting upon a specific resource.</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlfornotlisting">formatUrlForNotListing</a></p>
|
||||
<hr />
|
||||
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>get</strong>(<code>desc</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1288,63 +1356,13 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#get">get</a></p>
|
||||
<hr />
|
||||
<h3 id="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getResourceVersion</strong>(<code>namespace?</code>): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1360,21 +1378,70 @@
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
<td align="left"><code>{}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> instead</p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getwatchurl">getWatchUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="list">list<a class="headerlink" href="#list" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>list</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>[]></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1393,14 +1460,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>[]></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#list">list</a></p>
|
||||
<hr />
|
||||
<h3 id="modifywatchevent">modifyWatchEvent<a class="headerlink" href="#modifywatchevent" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>modifyWatchEvent</strong>(<code>event</code>): <code>void</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1415,14 +1482,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#modifywatchevent">modifyWatchEvent</a></p>
|
||||
<hr />
|
||||
<h3 id="normalizequery">normalizeQuery<a class="headerlink" href="#normalizequery" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>normalizeQuery</strong>(<code>query?</code>): <code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1437,14 +1504,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#normalizequery">normalizeQuery</a></p>
|
||||
<hr />
|
||||
<h3 id="parseresponse">parseResponse<a class="headerlink" href="#parseresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseResponse</strong>(<code>data</code>, <code>namespace?</code>): <code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>[]</p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1463,48 +1530,124 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>[]</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#parseresponse">parseResponse</a></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"merge"</code> | <code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"json"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code> | <code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>KubeApiPatchType</code></td>
|
||||
<td align="left"><code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<hr />
|
||||
<h3 id="refreshresourceversion">refreshResourceVersion<a class="headerlink" href="#refreshresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>refreshResourceVersion</strong>(<code>params?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>[]></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_17">Parameters<a class="headerlink" href="#parameters_17" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1519,14 +1662,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>[]></p>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#refreshresourceversion">refreshResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="setresourceversion">setResourceVersion<a class="headerlink" href="#setresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>setResourceVersion</strong>(<code>namespace?</code>, <code>newVersion</code>): <code>void</code></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_18">Parameters<a class="headerlink" href="#parameters_18" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1548,14 +1691,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#setresourceversion">setResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>update</strong>(<code>__namedParameters</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_19">Parameters<a class="headerlink" href="#parameters_19" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1574,14 +1717,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Node/"><code>Node</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#update">update</a></p>
|
||||
<hr />
|
||||
<h3 id="watch">watch<a class="headerlink" href="#watch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>watch</strong>(<code>opts?</code>): () => <code>void</code></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_20">Parameters<a class="headerlink" href="#parameters_20" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1591,17 +1734,17 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>opts</code></td>
|
||||
<td align="left"><code>opts?</code></td>
|
||||
<td align="left"><code>KubeApiWatchOptions</code><<a href="../Renderer.K8sApi.Node/"><code>Node</code></a>, <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#clusterscopedmetadata"><code>ClusterScopedMetadata</code></a>, <code>NodeStatus</code>, <code>NodeSpec</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p><code>fn</code></p>
|
||||
<p>▸ (): <code>void</code></p>
|
||||
<h5 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h5>
|
||||
<h5 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h5>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#watch">watch</a></p>
|
||||
|
||||
|
||||
|
||||
@@ -2206,7 +2206,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
+236
-93
@@ -944,6 +944,20 @@
|
||||
delete
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlforlisting" class="md-nav__link">
|
||||
formatUrlForListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlfornotlisting" class="md-nav__link">
|
||||
formatUrlForNotListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1095,6 +1109,8 @@
|
||||
<li><a href="./#checkpreferredversion">checkPreferredVersion</a></li>
|
||||
<li><a href="./#create">create</a></li>
|
||||
<li><a href="./#delete">delete</a></li>
|
||||
<li><a href="./#formaturlforlisting">formatUrlForListing</a></li>
|
||||
<li><a href="./#formaturlfornotlisting">formatUrlForNotListing</a></li>
|
||||
<li><a href="./#get">get</a></li>
|
||||
<li><a href="./#getresourceversion">getResourceVersion</a></li>
|
||||
<li><a href="./#geturl">getUrl</a></li>
|
||||
@@ -1267,9 +1283,61 @@
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#delete">delete</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlforlisting">formatUrlForListing<a class="headerlink" href="#formaturlforlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForListing</strong>(<code>namespace</code>): <code>string</code></p>
|
||||
<p>This method differs from <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> because this treats <code>""</code> as "all namespaces"</p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The namespace to list in or <code>""</code> for all namespaces</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlforlisting">formatUrlForListing</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlfornotlisting">formatUrlForNotListing<a class="headerlink" href="#formaturlfornotlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForNotListing</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p>Format a URL pathname and query for acting upon a specific resource.</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlfornotlisting">formatUrlForNotListing</a></p>
|
||||
<hr />
|
||||
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>get</strong>(<code>desc</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1288,63 +1356,13 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#get">get</a></p>
|
||||
<hr />
|
||||
<h3 id="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getResourceVersion</strong>(<code>namespace?</code>): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1360,21 +1378,70 @@
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
<td align="left"><code>{}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> instead</p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getwatchurl">getWatchUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="list">list<a class="headerlink" href="#list" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>list</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>[]></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1393,14 +1460,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>[]></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#list">list</a></p>
|
||||
<hr />
|
||||
<h3 id="modifywatchevent">modifyWatchEvent<a class="headerlink" href="#modifywatchevent" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>modifyWatchEvent</strong>(<code>event</code>): <code>void</code></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1415,14 +1482,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#modifywatchevent">modifyWatchEvent</a></p>
|
||||
<hr />
|
||||
<h3 id="normalizequery">normalizeQuery<a class="headerlink" href="#normalizequery" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>normalizeQuery</strong>(<code>query?</code>): <code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1437,14 +1504,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#normalizequery">normalizeQuery</a></p>
|
||||
<hr />
|
||||
<h3 id="parseresponse">parseResponse<a class="headerlink" href="#parseresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseResponse</strong>(<code>data</code>, <code>namespace?</code>): <code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>[]</p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1463,48 +1530,124 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>[]</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#parseresponse">parseResponse</a></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"merge"</code> | <code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"json"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code> | <code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>KubeApiPatchType</code></td>
|
||||
<td align="left"><code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<hr />
|
||||
<h3 id="refreshresourceversion">refreshResourceVersion<a class="headerlink" href="#refreshresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>refreshResourceVersion</strong>(<code>params?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>[]></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_17">Parameters<a class="headerlink" href="#parameters_17" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1519,14 +1662,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>[]></p>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#refreshresourceversion">refreshResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="setresourceversion">setResourceVersion<a class="headerlink" href="#setresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>setResourceVersion</strong>(<code>namespace?</code>, <code>newVersion</code>): <code>void</code></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_18">Parameters<a class="headerlink" href="#parameters_18" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1548,14 +1691,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#setresourceversion">setResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>update</strong>(<code>__namedParameters</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_19">Parameters<a class="headerlink" href="#parameters_19" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1574,14 +1717,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#update">update</a></p>
|
||||
<hr />
|
||||
<h3 id="watch">watch<a class="headerlink" href="#watch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>watch</strong>(<code>opts?</code>): () => <code>void</code></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_20">Parameters<a class="headerlink" href="#parameters_20" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1591,17 +1734,17 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>opts</code></td>
|
||||
<td align="left"><code>opts?</code></td>
|
||||
<td align="left"><code>KubeApiWatchOptions</code><<a href="../Renderer.K8sApi.PersistentVolumeClaim/"><code>PersistentVolumeClaim</code></a>, <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#namespacescopedmetadata"><code>NamespaceScopedMetadata</code></a>, <code>PersistentVolumeClaimStatus</code>, <code>PersistentVolumeClaimSpec</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p><code>fn</code></p>
|
||||
<p>▸ (): <code>void</code></p>
|
||||
<h5 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h5>
|
||||
<h5 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h5>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#watch">watch</a></p>
|
||||
|
||||
|
||||
|
||||
@@ -2200,7 +2200,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -1070,6 +1070,13 @@
|
||||
getRunningContainers
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#getruntimeclassname" class="md-nav__link">
|
||||
getRuntimeClassName
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1323,6 +1330,7 @@
|
||||
<li><a href="./#getresourceversion">getResourceVersion</a></li>
|
||||
<li><a href="./#getrestartscount">getRestartsCount</a></li>
|
||||
<li><a href="./#getrunningcontainers">getRunningContainers</a></li>
|
||||
<li><a href="./#getruntimeclassname">getRuntimeClassName</a></li>
|
||||
<li><a href="./#getscopedname">getScopedName</a></li>
|
||||
<li><a href="./#getsearchfields">getSearchFields</a></li>
|
||||
<li><a href="./#getsecrets">getSecrets</a></li>
|
||||
@@ -1692,33 +1700,38 @@ creation timestamp of this object.</p>
|
||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||
<p><a href="../../interfaces/Renderer.K8sApi.IPodContainer/"><code>IPodContainer</code></a>[]</p>
|
||||
<hr />
|
||||
<h3 id="getruntimeclassname">getRuntimeClassName<a class="headerlink" href="#getruntimeclassname" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getRuntimeClassName</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="getscopedname">getScopedName<a class="headerlink" href="#getscopedname" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getScopedName</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#getscopedname">getScopedName</a></p>
|
||||
<hr />
|
||||
<h3 id="getsearchfields">getSearchFields<a class="headerlink" href="#getsearchfields" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getSearchFields</strong>(): <code>string</code>[]</p>
|
||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code>[]</p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||
<hr />
|
||||
<h3 id="getsecrets">getSecrets<a class="headerlink" href="#getsecrets" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getSecrets</strong>(): <code>string</code>[]</p>
|
||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code>[]</p>
|
||||
<hr />
|
||||
<h3 id="getselectednodeos">getSelectedNodeOs<a class="headerlink" href="#getselectednodeos" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getSelectedNodeOs</strong>(): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="getserviceaccountname">getServiceAccountName<a class="headerlink" href="#getserviceaccountname" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getServiceAccountName</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="getstartupprobe">getStartupProbe<a class="headerlink" href="#getstartupprobe" title="Permanent link">#</a></h3>
|
||||
@@ -1738,22 +1751,22 @@ creation timestamp of this object.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code>[]</p>
|
||||
<hr />
|
||||
<h3 id="getstatus">getStatus<a class="headerlink" href="#getstatus" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getStatus</strong>(): <code>PodStatusPhase</code></p>
|
||||
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
||||
<p><code>PodStatusPhase</code></p>
|
||||
<hr />
|
||||
<h3 id="getstatusmessage">getStatusMessage<a class="headerlink" href="#getstatusmessage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getStatusMessage</strong>(): <code>string</code></p>
|
||||
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="getstatusphase">getStatusPhase<a class="headerlink" href="#getstatusphase" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getStatusPhase</strong>(): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="gettimedifffromnow">getTimeDiffFromNow<a class="headerlink" href="#gettimedifffromnow" title="Permanent link">#</a></h3>
|
||||
@@ -1761,24 +1774,24 @@ creation timestamp of this object.</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_39">Returns<a class="headerlink" href="#returns_39" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||
<hr />
|
||||
<h3 id="gettolerations">getTolerations<a class="headerlink" href="#gettolerations" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getTolerations</strong>(): <code>Toleration</code>[]</p>
|
||||
<h4 id="returns_39">Returns<a class="headerlink" href="#returns_39" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_40">Returns<a class="headerlink" href="#returns_40" title="Permanent link">#</a></h4>
|
||||
<p><code>Toleration</code>[]</p>
|
||||
<hr />
|
||||
<h3 id="getvolumes">getVolumes<a class="headerlink" href="#getvolumes" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getVolumes</strong>(): <code>PodSpecVolume</code>[]</p>
|
||||
<h4 id="returns_40">Returns<a class="headerlink" href="#returns_40" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_41">Returns<a class="headerlink" href="#returns_41" title="Permanent link">#</a></h4>
|
||||
<p><code>PodSpecVolume</code>[]</p>
|
||||
<hr />
|
||||
<h3 id="hasissues">hasIssues<a class="headerlink" href="#hasissues" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>hasIssues</strong>(): <code>boolean</code></p>
|
||||
<h4 id="returns_41">Returns<a class="headerlink" href="#returns_41" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_42">Returns<a class="headerlink" href="#returns_42" title="Permanent link">#</a></h4>
|
||||
<p><code>boolean</code></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
@@ -1800,14 +1813,14 @@ creation timestamp of this object.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_42">Returns<a class="headerlink" href="#returns_42" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_43">Returns<a class="headerlink" href="#returns_43" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#patch">patch</a></p>
|
||||
<hr />
|
||||
<h3 id="toplainobject">toPlainObject<a class="headerlink" href="#toplainobject" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>toPlainObject</strong>(): <code>JsonObject</code></p>
|
||||
<h4 id="returns_43">Returns<a class="headerlink" href="#returns_43" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_44">Returns<a class="headerlink" href="#returns_44" title="Permanent link">#</a></h4>
|
||||
<p><code>JsonObject</code></p>
|
||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#toplainobject">toPlainObject</a></p>
|
||||
@@ -1835,7 +1848,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_44">Returns<a class="headerlink" href="#returns_44" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_45">Returns<a class="headerlink" href="#returns_45" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#update">update</a></p>
|
||||
@@ -1880,7 +1893,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_45">Returns<a class="headerlink" href="#returns_45" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_46">Returns<a class="headerlink" href="#returns_46" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#create">create</a></p>
|
||||
@@ -1902,7 +1915,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_46">Returns<a class="headerlink" href="#returns_46" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_47">Returns<a class="headerlink" href="#returns_47" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||
@@ -1941,7 +1954,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_47">Returns<a class="headerlink" href="#returns_47" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_48">Returns<a class="headerlink" href="#returns_48" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiDataList<T></p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||
@@ -1963,7 +1976,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_48">Returns<a class="headerlink" href="#returns_48" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_49">Returns<a class="headerlink" href="#returns_49" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiListMetadata</p>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||
@@ -1985,7 +1998,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_49">Returns<a class="headerlink" href="#returns_49" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_50">Returns<a class="headerlink" href="#returns_50" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||
@@ -2007,7 +2020,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_50">Returns<a class="headerlink" href="#returns_50" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_51">Returns<a class="headerlink" href="#returns_51" title="Permanent link">#</a></h4>
|
||||
<p><code>boolean</code></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||
@@ -2029,7 +2042,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_51">Returns<a class="headerlink" href="#returns_51" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_52">Returns<a class="headerlink" href="#returns_52" title="Permanent link">#</a></h4>
|
||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||
@@ -2051,7 +2064,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_52">Returns<a class="headerlink" href="#returns_52" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_53">Returns<a class="headerlink" href="#returns_53" title="Permanent link">#</a></h4>
|
||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||
@@ -2073,7 +2086,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_53">Returns<a class="headerlink" href="#returns_53" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_54">Returns<a class="headerlink" href="#returns_54" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code>[]</p>
|
||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -944,6 +944,20 @@
|
||||
delete
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlforlisting" class="md-nav__link">
|
||||
formatUrlForListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#formaturlfornotlisting" class="md-nav__link">
|
||||
formatUrlForNotListing
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1102,6 +1116,8 @@
|
||||
<li><a href="./#checkpreferredversion">checkPreferredVersion</a></li>
|
||||
<li><a href="./#create">create</a></li>
|
||||
<li><a href="./#delete">delete</a></li>
|
||||
<li><a href="./#formaturlforlisting">formatUrlForListing</a></li>
|
||||
<li><a href="./#formaturlfornotlisting">formatUrlForNotListing</a></li>
|
||||
<li><a href="./#get">get</a></li>
|
||||
<li><a href="./#getlogs">getLogs</a></li>
|
||||
<li><a href="./#getresourceversion">getResourceVersion</a></li>
|
||||
@@ -1275,9 +1291,61 @@
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#delete">delete</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlforlisting">formatUrlForListing<a class="headerlink" href="#formaturlforlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForListing</strong>(<code>namespace</code>): <code>string</code></p>
|
||||
<p>This method differs from <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> because this treats <code>""</code> as "all namespaces"</p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The namespace to list in or <code>""</code> for all namespaces</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlforlisting">formatUrlForListing</a></p>
|
||||
<hr />
|
||||
<h3 id="formaturlfornotlisting">formatUrlForNotListing<a class="headerlink" href="#formaturlfornotlisting" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>formatUrlForNotListing</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p>Format a URL pathname and query for acting upon a specific resource.</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#formaturlfornotlisting">formatUrlForNotListing</a></p>
|
||||
<hr />
|
||||
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>get</strong>(<code>desc</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1296,14 +1364,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#get">get</a></p>
|
||||
<hr />
|
||||
<h3 id="getlogs">getLogs<a class="headerlink" href="#getlogs" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getLogs</strong>(<code>params</code>, <code>query?</code>): <code>Promise</code><<code>string</code>></p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1322,61 +1390,11 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>string</code>></p>
|
||||
<hr />
|
||||
<h3 id="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getResourceVersion</strong>(<code>namespace?</code>): <code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1392,21 +1410,70 @@
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left"><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
<td align="left"><code>{}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<p><code>undefined</code> | <code>string</code></p>
|
||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getresourceversion">getResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="geturl">getUrl<a class="headerlink" href="#geturl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getUrl</strong>(<code>resource?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use <a href="./#formaturlfornotlisting">formatUrlForNotListing</a> instead</p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>resource?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>ResourceDescriptor</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query?</code></td>
|
||||
<td align="left"><code>Partial</code><<code>KubeApiQueryParams</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#geturl">getUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="getwatchurl">getWatchUrl<a class="headerlink" href="#getwatchurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getWatchUrl</strong>(<code>namespace?</code>, <code>query?</code>): <code>string</code></p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>namespace?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>query</code></td>
|
||||
<td align="left"><code>KubeApiQueryParams</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#getwatchurl">getWatchUrl</a></p>
|
||||
<hr />
|
||||
<h3 id="list">list<a class="headerlink" href="#list" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>list</strong>(<code>__namedParameters?</code>, <code>query?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>[]></p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1425,14 +1492,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>[]></p>
|
||||
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#list">list</a></p>
|
||||
<hr />
|
||||
<h3 id="modifywatchevent">modifyWatchEvent<a class="headerlink" href="#modifywatchevent" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>modifyWatchEvent</strong>(<code>event</code>): <code>void</code></p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1447,14 +1514,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#modifywatchevent">modifyWatchEvent</a></p>
|
||||
<hr />
|
||||
<h3 id="normalizequery">normalizeQuery<a class="headerlink" href="#normalizequery" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>normalizeQuery</strong>(<code>query?</code>): <code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1469,14 +1536,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>Partial</code><<code>KubeApiQueryParams</code>></p>
|
||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#normalizequery">normalizeQuery</a></p>
|
||||
<hr />
|
||||
<h3 id="parseresponse">parseResponse<a class="headerlink" href="#parseresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseResponse</strong>(<code>data</code>, <code>namespace?</code>): <code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>[]</p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1495,48 +1562,124 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>[]</p>
|
||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#parseresponse">parseResponse</a></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"merge"</code> | <code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>"json"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<p>▸ <strong>patch</strong>(<code>desc</code>, <code>data</code>, <code>strategy</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="parameters_17">Parameters<a class="headerlink" href="#parameters_17" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Default value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>desc</code></td>
|
||||
<td align="left"><code>ResourceDescriptor</code></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Patch</code> | <code>PartialObjectDeep</code><<a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></td>
|
||||
<td align="left"><code>undefined</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strategy</code></td>
|
||||
<td align="left"><code>KubeApiPatchType</code></td>
|
||||
<td align="left"><code>"strategic"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#patch">patch</a></p>
|
||||
<hr />
|
||||
<h3 id="refreshresourceversion">refreshResourceVersion<a class="headerlink" href="#refreshresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>refreshResourceVersion</strong>(<code>params?</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>[]></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_18">Parameters<a class="headerlink" href="#parameters_18" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1551,14 +1694,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>[]></p>
|
||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#refreshresourceversion">refreshResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="setresourceversion">setResourceVersion<a class="headerlink" href="#setresourceversion" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>setResourceVersion</strong>(<code>namespace?</code>, <code>newVersion</code>): <code>void</code></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_19">Parameters<a class="headerlink" href="#parameters_19" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1580,14 +1723,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#setresourceversion">setResourceVersion</a></p>
|
||||
<hr />
|
||||
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>update</strong>(<code>__namedParameters</code>, <code>data</code>): <code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_20">Parameters<a class="headerlink" href="#parameters_20" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1606,14 +1749,14 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>></p>
|
||||
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#update">update</a></p>
|
||||
<hr />
|
||||
<h3 id="watch">watch<a class="headerlink" href="#watch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>watch</strong>(<code>opts?</code>): () => <code>void</code></p>
|
||||
<h4 id="parameters_16">Parameters<a class="headerlink" href="#parameters_16" title="Permanent link">#</a></h4>
|
||||
<h4 id="parameters_21">Parameters<a class="headerlink" href="#parameters_21" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1623,17 +1766,17 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>opts</code></td>
|
||||
<td align="left"><code>opts?</code></td>
|
||||
<td align="left"><code>KubeApiWatchOptions</code><<a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a>, <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#namespacescopedmetadata"><code>NamespaceScopedMetadata</code></a>, <code>PodStatus</code>, <code>PodSpec</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||
<p><code>fn</code></p>
|
||||
<p>▸ (): <code>void</code></p>
|
||||
<h5 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h5>
|
||||
<h5 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h5>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#watch">watch</a></p>
|
||||
|
||||
|
||||
|
||||
@@ -2379,7 +2379,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2288,7 +2288,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2168,7 +2168,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2260,7 +2260,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2210,7 +2210,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -2172,7 +2172,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>order?</code></td>
|
||||
<td align="left"><code>"desc"</code> | <code>"asc"</code></td>
|
||||
<td align="left"><code>"asc"</code> | <code>"desc"</code></td>
|
||||
<td align="left">whether to sort from least to greatest (<code>"asc"</code> (default)) or vice-versa (<code>"desc"</code>)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -1205,12 +1205,12 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@29323</p>
|
||||
<p>LensExtension.__@Disposers@30074</p>
|
||||
<hr />
|
||||
<h3 id="lensextensiondependencies">[lensExtensionDependencies]<a class="headerlink" href="#lensextensiondependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[lensExtensionDependencies]</strong>: <code>LensRendererExtensionDependencies</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@lensExtensionDependencies@29326</p>
|
||||
<p>LensExtension.__@lensExtensionDependencies@30077</p>
|
||||
<hr />
|
||||
<h3 id="additionalcategorycolumns">additionalCategoryColumns<a class="headerlink" href="#additionalcategorycolumns" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>additionalCategoryColumns</strong>: <a href="../../interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/"><code>AdditionalCategoryColumnRegistration</code></a>[] = <code>[]</code></p>
|
||||
|
||||
Reference in new issue
Block a user