mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed d44599af00 to master with MkDocs 1.3.0 and mike 1.1.2
This commit is contained in:
GitHub Action committed
1 parent
49b277952a
commit
f5e9d26853
82 files changed
+3649
-1610
No files matched your search
@@ -1102,7 +1102,7 @@
|
||||
<p><a href="../../modules/Renderer/">Renderer</a>.<a href="../../modules/Renderer.K8sApi/">K8sApi</a>.Endpoint</p>
|
||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||
<ul>
|
||||
<li><a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>void</code>, <code>void</code>, <code>KubeObjectScope.Namespace</code>></li>
|
||||
<li><a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Renderer.K8sApi/#namespacescopedmetadata"><code>NamespaceScopedMetadata</code></a>, <code>void</code>, <code>void</code>></li>
|
||||
</ul>
|
||||
<p>↳ <strong><code>Endpoint</code></strong></p>
|
||||
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||
@@ -1189,7 +1189,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#kind">kind</a></p>
|
||||
<hr />
|
||||
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>metadata</strong>: <a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>Namespace</code>></p>
|
||||
<p>• <strong>metadata</strong>: <a href="../../modules/Renderer.K8sApi/#namespacescopedmetadata"><code>NamespaceScopedMetadata</code></a></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#metadata">metadata</a></p>
|
||||
<hr />
|
||||
@@ -1229,7 +1229,7 @@
|
||||
<p>KubeObject.selfLink</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><<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>delete</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>
|
||||
<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>
|
||||
@@ -1247,7 +1247,7 @@
|
||||
</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><<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><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="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#delete">delete</a></p>
|
||||
<hr />
|
||||
@@ -1398,7 +1398,7 @@ creation timestamp of this object.</p>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></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>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>patch</strong>(<code>patch</code>): <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>
|
||||
<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>
|
||||
@@ -1416,7 +1416,7 @@ creation timestamp of this object.</p>
|
||||
</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>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><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_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/#patch">patch</a></p>
|
||||
<hr />
|
||||
@@ -1433,7 +1433,7 @@ creation timestamp of this object.</p>
|
||||
<p><code>string</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>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>update</strong>(<code>data</code>): <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>
|
||||
<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
|
||||
@@ -1455,12 +1455,12 @@ common race condition.</p>
|
||||
</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> | <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><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_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/#update">update</a></p>
|
||||
<hr />
|
||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>create</strong><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Status</code>, <code>Spec</code>, <code>KubeObjectScope</code>></p>
|
||||
<p>▸ <code>Static</code> <strong>create</strong><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1495,17 +1495,17 @@ common race condition.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>data</code></td>
|
||||
<td align="left"><code>KubeJsonApiData</code><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></td>
|
||||
<td align="left"><a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Status</code>, <code>Spec</code>, <code>KubeObjectScope</code>></p>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</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/#create">create</a></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<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>, unknown, unknown></p>
|
||||
<p>▸ <code>Static</code> <strong>isJsonApiData</strong>(<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1522,7 +1522,7 @@ common race condition.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||
<p>object is KubeJsonApiData<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>, unknown, unknown></p>
|
||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></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/#isjsonapidata">isJsonApiData</a></p>
|
||||
<hr />
|
||||
@@ -1588,7 +1588,7 @@ common race condition.</p>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></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 BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster></p>
|
||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>(<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1605,7 +1605,7 @@ common race condition.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||
<p>object is BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster></p>
|
||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||
<hr />
|
||||
@@ -1622,7 +1622,7 @@ common race condition.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>item</code></td>
|
||||
<td align="left"><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>> | <a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>unknown</code>, <code>unknown</code>, <code>KubeObjectScope</code>></td>
|
||||
<td align="left"><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>> | <a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</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>
|
||||
@@ -1632,7 +1632,7 @@ common race condition.</p>
|
||||
<p><a href="../Renderer.K8sApi.KubeObject/">KubeObject</a>.<a href="../Renderer.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></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<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>, unknown, unknown>></p>
|
||||
<p>▸ <code>Static</code> <strong>isPartialJsonApiData</strong>(<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1649,12 +1649,12 @@ common race condition.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||
<p>object is Partial<KubeJsonApiData<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>, unknown, unknown>></p>
|
||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></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/#ispartialjsonapidata">isPartialJsonApiData</a></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<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>></p>
|
||||
<p>▸ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>(<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1671,7 +1671,7 @@ common race condition.</p>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||
<p>object is Partial<BaseKubeJsonApiObjectMetadata<Namespace> & Object | BaseKubeJsonApiObjectMetadata<Cluster>></p>
|
||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||
<hr />
|
||||
|
||||
Reference in new issue
Block a user