mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed dfcb7c3330 to master with MkDocs 1.3.0 and mike 1.1.2
This commit is contained in:
GitHub Action committed
1 parent
b19c26da49
commit
0371d26c96
185 files changed
+13701
-40588
No files matched your search
@@ -88,7 +88,7 @@
|
||||
<div data-md-component="skip">
|
||||
|
||||
|
||||
<a href="#class-kubeobjectmetadata-status-spec" class="md-skip">
|
||||
<a href="#class-kubeobjectstatus-spec-namespaced" class="md-skip">
|
||||
Skip to content
|
||||
</a>
|
||||
|
||||
@@ -126,7 +126,7 @@
|
||||
<div class="md-header__topic" data-md-component="header-topic">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Class: KubeObject<Metadata, Status, Spec\>
|
||||
Class: KubeObject<Status, Spec, Namespaced\>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
@@ -813,13 +813,6 @@
|
||||
kind
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#managedfields" class="md-nav__link">
|
||||
managedFields
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -972,6 +965,13 @@
|
||||
getResourceVersion
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#getscopedname" class="md-nav__link">
|
||||
getScopedName
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1091,7 +1091,7 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="class-kubeobjectmetadata-status-spec">Class: KubeObject<Metadata, Status, Spec><a class="headerlink" href="#class-kubeobjectmetadata-status-spec" title="Permanent link">#</a></h1>
|
||||
<h1 id="class-kubeobjectstatus-spec-namespaced">Class: KubeObject<Status, Spec, Namespaced><a class="headerlink" href="#class-kubeobjectstatus-spec-namespaced" title="Permanent link">#</a></h1>
|
||||
<p><a href="../../modules/Renderer/">Renderer</a>.<a href="../../modules/Renderer.K8sApi/">K8sApi</a>.KubeObject</p>
|
||||
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
|
||||
<table>
|
||||
@@ -1103,16 +1103,16 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>Metadata</code></td>
|
||||
<td align="left">extends <a href="../../interfaces/Renderer.K8sApi.KubeObjectMetadata/"><code>KubeObjectMetadata</code></a> = <a href="../../interfaces/Renderer.K8sApi.KubeObjectMetadata/"><code>KubeObjectMetadata</code></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Status</code></td>
|
||||
<td align="left"><code>any</code></td>
|
||||
<td align="left"><code>unknown</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Spec</code></td>
|
||||
<td align="left"><code>any</code></td>
|
||||
<td align="left"><code>unknown</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Namespaced</code></td>
|
||||
<td align="left">extends <code>KubeObjectScope</code> = <code>KubeObjectScope</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1120,10 +1120,16 @@
|
||||
<ul>
|
||||
<li><strong><code>KubeObject</code></strong></li>
|
||||
</ul>
|
||||
<p>↳ <a href="../Renderer.K8sApi.Pod/"><code>Pod</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.Node/"><code>Node</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.Deployment/"><code>Deployment</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.DaemonSet/"><code>DaemonSet</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.StatefulSet/"><code>StatefulSet</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.Job/"><code>Job</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.CronJob/"><code>CronJob</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.ConfigMap/"><code>ConfigMap</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.Secret/"><code>Secret</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.ReplicaSet/"><code>ReplicaSet</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.ResourceQuota/"><code>ResourceQuota</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.LimitRange/"><code>LimitRange</code></a></p>
|
||||
<p>↳ <a href="../Renderer.K8sApi.HorizontalPodAutoscaler/"><code>HorizontalPodAutoscaler</code></a></p>
|
||||
@@ -1156,12 +1162,11 @@
|
||||
<ul>
|
||||
<li><a href="./#apiversion">apiVersion</a></li>
|
||||
<li><a href="./#kind">kind</a></li>
|
||||
<li><a href="./#managedfields">managedFields</a></li>
|
||||
<li><a href="./#metadata">metadata</a></li>
|
||||
<li><a href="./#spec">spec</a></li>
|
||||
<li><a href="./#status">status</a></li>
|
||||
<li><a href="./#apibase">apiBase</a></li>
|
||||
<li><a href="./#kind">kind</a></li>
|
||||
<li><a href="./#kind-1">kind</a></li>
|
||||
<li><a href="./#namespaced">namespaced</a></li>
|
||||
</ul>
|
||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||
@@ -1181,6 +1186,7 @@
|
||||
<li><a href="./#getns">getNs</a></li>
|
||||
<li><a href="./#getownerrefs">getOwnerRefs</a></li>
|
||||
<li><a href="./#getresourceversion">getResourceVersion</a></li>
|
||||
<li><a href="./#getscopedname">getScopedName</a></li>
|
||||
<li><a href="./#getsearchfields">getSearchFields</a></li>
|
||||
<li><a href="./#gettimedifffromnow">getTimeDiffFromNow</a></li>
|
||||
<li><a href="./#patch">patch</a></li>
|
||||
@@ -1198,7 +1204,7 @@
|
||||
</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 KubeObject</strong><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>)</p>
|
||||
<p>• <strong>new KubeObject</strong><<code>Status</code>, <code>Spec</code>, <code>Namespaced</code>>(<code>data</code>)</p>
|
||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1209,16 +1215,16 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>Metadata</code></td>
|
||||
<td align="left">extends <a href="../../interfaces/Renderer.K8sApi.KubeObjectMetadata/"><code>KubeObjectMetadata</code></a> = <a href="../../interfaces/Renderer.K8sApi.KubeObjectMetadata/"><code>KubeObjectMetadata</code></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Status</code></td>
|
||||
<td align="left"><code>any</code></td>
|
||||
<td align="left"><code>unknown</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Spec</code></td>
|
||||
<td align="left"><code>any</code></td>
|
||||
<td align="left"><code>unknown</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Namespaced</code></td>
|
||||
<td align="left">extends <code>KubeObjectScope</code> = <code>KubeObjectScope</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1233,7 +1239,7 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>KubeJsonApiData</code></td>
|
||||
<td align="left"><code>KubeJsonApiData</code><<a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>Namespaced</code>>, <code>Status</code>, <code>Spec</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1244,14 +1250,11 @@
|
||||
<h3 id="kind">kind<a class="headerlink" href="#kind" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>kind</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="managedfields">managedFields<a class="headerlink" href="#managedfields" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>managedFields</strong>: <code>any</code></p>
|
||||
<hr />
|
||||
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>metadata</strong>: <code>Metadata</code></p>
|
||||
<p>• <strong>metadata</strong>: <a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>Namespaced</code>></p>
|
||||
<hr />
|
||||
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>spec</strong>: <code>Spec</code></p>
|
||||
<p>• <strong>spec</strong>: <code>Spec</code></p>
|
||||
<hr />
|
||||
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>status</strong>: <code>Status</code></p>
|
||||
@@ -1271,7 +1274,7 @@
|
||||
<p><code>string</code></p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<code>KubeJsonApiData</code>></p>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<code>KubeJsonApiData</code><<a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Namespace</code>> & { <code>namespace</code>: <code>string</code> } | <a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Cluster</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@@ -1284,12 +1287,12 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>JsonApiParams</code><<code>any</code>></td>
|
||||
<td align="left"><code>object</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>KubeJsonApiData</code>></p>
|
||||
<p><code>Promise</code><<code>KubeJsonApiData</code><<a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Namespace</code>> & { <code>namespace</code>: <code>string</code> } | <a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Cluster</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
@@ -1379,34 +1382,39 @@ creation timestamp of this object.</p>
|
||||
<p>ItemObject.getName</p>
|
||||
<hr />
|
||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||
<p>▸ <strong>getNs</strong>(): <code>ScopedNamespace</code><<code>Namespaced</code>></p>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<p><code>ScopedNamespace</code><<code>Namespaced</code>></p>
|
||||
<hr />
|
||||
<h3 id="getownerrefs">getOwnerRefs<a class="headerlink" href="#getownerrefs" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getOwnerRefs</strong>(): { <code>apiVersion</code>: <code>string</code> ; <code>blockOwnerDeletion</code>: <code>boolean</code> ; <code>controller</code>: <code>boolean</code> ; <code>kind</code>: <code>string</code> ; <code>name</code>: <code>string</code> ; <code>namespace</code>: <code>string</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||
<p>▸ <strong>getOwnerRefs</strong>(): { <code>apiVersion</code>: <code>string</code> ; <code>blockOwnerDeletion?</code>: <code>boolean</code> ; <code>controller?</code>: <code>boolean</code> ; <code>kind</code>: <code>string</code> ; <code>name</code>: <code>string</code> ; <code>namespace</code>: <code>ScopedNamespace</code><<code>Namespaced</code>> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p>{ <code>apiVersion</code>: <code>string</code> ; <code>blockOwnerDeletion</code>: <code>boolean</code> ; <code>controller</code>: <code>boolean</code> ; <code>kind</code>: <code>string</code> ; <code>name</code>: <code>string</code> ; <code>namespace</code>: <code>string</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||
<p>{ <code>apiVersion</code>: <code>string</code> ; <code>blockOwnerDeletion?</code>: <code>boolean</code> ; <code>controller?</code>: <code>boolean</code> ; <code>kind</code>: <code>string</code> ; <code>name</code>: <code>string</code> ; <code>namespace</code>: <code>ScopedNamespace</code><<code>Namespaced</code>> ; <code>uid</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>string</code></p>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="getsearchfields">getSearchFields<a class="headerlink" href="#getsearchfields" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getSearchFields</strong>(): <code>string</code>[]</p>
|
||||
<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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code>[]</p>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="getsearchfields">getSearchFields<a class="headerlink" href="#getsearchfields" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getSearchFields</strong>(): (<code>string</code> | <code>ScopedNamespace</code><<code>Namespaced</code>>)[]</p>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p>(<code>string</code> | <code>ScopedNamespace</code><<code>Namespaced</code>>)[]</p>
|
||||
<hr />
|
||||
<h3 id="gettimedifffromnow">getTimeDiffFromNow<a class="headerlink" href="#gettimedifffromnow" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getTimeDiffFromNow</strong>(): <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> 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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>KubeJsonApiData</code>></p>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <code>KubeJsonApiData</code><<a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Namespace</code>> & { <code>namespace</code>: <code>string</code> } | <a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Cluster</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@@ -1423,16 +1431,16 @@ creation timestamp of this object.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>KubeJsonApiData</code>></p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>KubeJsonApiData</code><<a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Namespace</code>> & { <code>namespace</code>: <code>string</code> } | <a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Cluster</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<hr />
|
||||
<h3 id="toplainobject">toPlainObject<a class="headerlink" href="#toplainobject" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>toPlainObject</strong>(): <code>object</code></p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>object</code></p>
|
||||
<p>▸ <strong>toPlainObject</strong>(): <code>JsonObject</code></p>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>JsonObject</code></p>
|
||||
<hr />
|
||||
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>update</strong>(<code>data</code>): <code>Promise</code><<code>KubeJsonApiData</code>></p>
|
||||
<p>▸ <strong>update</strong>(<code>data</code>): <code>Promise</code><<code>null</code> | <code>KubeJsonApiData</code><<a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Namespace</code>> & { <code>namespace</code>: <code>string</code> } | <a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Cluster</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p>Perform a full update (or more specifically a replace)</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
@@ -1449,15 +1457,38 @@ common race condition.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>Partial</code><<a href="./"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>></td>
|
||||
<td align="left"><code>Partial</code><<a href="./"><code>KubeObject</code></a><<code>Status</code>, <code>Spec</code>, <code>Namespaced</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>KubeJsonApiData</code>></p>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>null</code> | <code>KubeJsonApiData</code><<a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Namespace</code>> & { <code>namespace</code>: <code>string</code> } | <a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Cluster</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<hr />
|
||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>create</strong>(<code>data</code>): <a href="./"><code>KubeObject</code></a><<a href="../../interfaces/Renderer.K8sApi.KubeObjectMetadata/"><code>KubeObjectMetadata</code></a>, <code>any</code>, <code>any</code>></p>
|
||||
<p>▸ <code>Static</code> <strong>create</strong><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="./"><code>KubeObject</code></a><<code>Status</code>, <code>Spec</code>, <code>KubeObjectScope</code>></p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" 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>Metadata</code></td>
|
||||
<td align="left">extends <a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>> = <a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Status</code></td>
|
||||
<td align="left"><code>unknown</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Spec</code></td>
|
||||
<td align="left"><code>unknown</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1469,15 +1500,15 @@ common race condition.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>KubeJsonApiData</code></td>
|
||||
<td align="left"><code>KubeJsonApiData</code><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><a href="./"><code>KubeObject</code></a><<a href="../../interfaces/Renderer.K8sApi.KubeObjectMetadata/"><code>KubeObjectMetadata</code></a>, <code>any</code>, <code>any</code>></p>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p><a href="./"><code>KubeObject</code></a><<code>Status</code>, <code>Spec</code>, <code>KubeObjectScope</code>></p>
|
||||
<hr />
|
||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isJsonApiData</strong>(<code>object</code>): object is KubeJsonApiData</p>
|
||||
<p>▸ <code>Static</code> <strong>isJsonApiData</strong>(<code>object</code>): object is KubeJsonApiData<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>, unknown, unknown></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1493,12 +1524,12 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiData</p>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiData<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>, unknown, unknown></p>
|
||||
<hr />
|
||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isJsonApiDataList</strong><<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<h4 id="type-parameters_3">Type parameters<a class="headerlink" href="#type-parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1530,7 +1561,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiDataList<T></p>
|
||||
<hr />
|
||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||
@@ -1550,11 +1581,11 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiListMetadata</p>
|
||||
<hr />
|
||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>(<code>object</code>): object is KubeJsonApiMetadata</p>
|
||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>(<code>object</code>): object is BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster></p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1570,8 +1601,8 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiMetadata</p>
|
||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||
<p>object is BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster></p>
|
||||
<hr />
|
||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isNonSystem</strong>(<code>item</code>): <code>boolean</code></p>
|
||||
@@ -1586,15 +1617,15 @@ common race condition.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>item</code></td>
|
||||
<td align="left"><a href="./"><code>KubeObject</code></a><<a href="../../interfaces/Renderer.K8sApi.KubeObjectMetadata/"><code>KubeObjectMetadata</code></a>, <code>any</code>, <code>any</code>> | <code>KubeJsonApiData</code></td>
|
||||
<td align="left"><a href="./"><code>KubeObject</code></a><<code>unknown</code>, <code>unknown</code>, <code>KubeObjectScope</code>> | <code>KubeJsonApiData</code><<a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Namespace</code>> & { <code>namespace</code>: <code>string</code> } | <a href="../../interfaces/Renderer.K8sApi.BaseKubeJsonApiObjectMetadata/"><code>BaseKubeJsonApiObjectMetadata</code></a><<code>Cluster</code>>, <code>unknown</code>, <code>unknown</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||
<p><code>boolean</code></p>
|
||||
<hr />
|
||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isPartialJsonApiData</strong>(<code>object</code>): object is Partial<KubeJsonApiData></p>
|
||||
<p>▸ <code>Static</code> <strong>isPartialJsonApiData</strong>(<code>object</code>): object is Partial<KubeJsonApiData<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>, unknown, unknown>></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1610,11 +1641,11 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||
<p>object is Partial<KubeJsonApiData></p>
|
||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||
<p>object is Partial<KubeJsonApiData<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>, unknown, unknown>></p>
|
||||
<hr />
|
||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>(<code>object</code>): object is Partial<KubeJsonApiMetadata></p>
|
||||
<p>▸ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>(<code>object</code>): object is Partial<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1630,8 +1661,8 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||
<p>object is Partial<KubeJsonApiMetadata></p>
|
||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||
<p>object is Partial<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>></p>
|
||||
<hr />
|
||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>stringifyLabels</strong>(<code>labels?</code>): <code>string</code>[]</p>
|
||||
@@ -1646,11 +1677,11 @@ common race condition.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>labels?</code></td>
|
||||
<td align="left"><code>Object</code></td>
|
||||
<td align="left"><code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code>[]</p>
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user