mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed f2f6cc500c to master with MkDocs 1.4.2 and mike 1.1.2
This commit is contained in:
GitHub Action
parent
c2825a795a
commit
18e86df4bc
@ -846,6 +846,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -860,6 +916,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1019,69 +1082,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1127,8 +1127,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1154,15 +1163,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1221,251 +1221,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getrules">getRules<a class="headerlink" href="#getrules" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getRules</strong>(): <code>PolicyRule</code>[]</p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>PolicyRule</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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>ClusterRole</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1488,7 +1250,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1503,14 +1265,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1525,14 +1291,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1545,7 +1315,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1564,14 +1334,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1586,14 +1360,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1608,14 +1386,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1630,14 +1412,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1652,14 +1438,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1674,14 +1464,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1696,10 +1500,237 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code></p>
|
||||||
|
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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>undefined</code> ; <code>uid</code>: <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getrules">getRules<a class="headerlink" href="#getrules" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getRules</strong>(): <code>PolicyRule</code>[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>PolicyRule</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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>ClusterRole</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -846,6 +846,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -860,6 +916,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1026,69 +1089,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1134,8 +1134,17 @@
|
|||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#subjects">subjects</a></li>
|
<li><a href="./#subjects">subjects</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1162,15 +1171,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1229,256 +1229,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getsubjectnames">getSubjectNames<a class="headerlink" href="#getsubjectnames" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSubjectNames</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getsubjects">getSubjects<a class="headerlink" href="#getsubjects" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSubjects</strong>(): <code>Subject</code>[]</p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Subject</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></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_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>ClusterRoleBinding</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1501,7 +1258,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1516,14 +1273,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1538,14 +1299,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1558,7 +1323,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1577,14 +1342,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1599,14 +1368,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1621,14 +1394,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1643,14 +1420,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1665,14 +1446,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1687,14 +1472,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1709,10 +1508,242 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code></p>
|
||||||
|
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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>undefined</code> ; <code>uid</code>: <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getsubjectnames">getSubjectNames<a class="headerlink" href="#getsubjectnames" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSubjectNames</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getsubjects">getSubjects<a class="headerlink" href="#getsubjects" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSubjects</strong>(): <code>Subject</code>[]</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Subject</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>ClusterRoleBinding</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -853,6 +853,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -867,6 +923,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1026,69 +1089,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1135,8 +1135,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1162,15 +1171,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1232,251 +1232,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getkeys">getKeys<a class="headerlink" href="#getkeys" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getKeys</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" 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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>ConfigMap</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1499,7 +1261,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1514,14 +1276,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1536,14 +1302,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1556,7 +1326,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1575,14 +1345,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1597,14 +1371,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1619,14 +1397,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1641,14 +1423,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1663,14 +1449,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1685,14 +1475,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1707,10 +1511,237 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getkeys">getKeys<a class="headerlink" href="#getkeys" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getKeys</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>ConfigMap</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1033,69 +1096,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1139,8 +1139,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1170,15 +1179,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1231,271 +1231,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"CronJob"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlastscheduletime">getLastScheduleTime<a class="headerlink" href="#getlastscheduletime" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLastScheduleTime</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getschedule">getSchedule<a class="headerlink" href="#getschedule" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSchedule</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" 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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getsuspendflag">getSuspendFlag<a class="headerlink" href="#getsuspendflag" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSuspendFlag</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="isneverrun">isNeverRun<a class="headerlink" href="#isneverrun" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isNeverRun</strong>(): <code>boolean</code></p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>boolean</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="issuspend">isSuspend<a class="headerlink" href="#issuspend" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isSuspend</strong>(): <code>undefined</code> | <code>boolean</code></p>
|
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>boolean</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>CronJob</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1518,7 +1260,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1533,14 +1275,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1555,14 +1301,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1575,7 +1325,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1594,14 +1344,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1616,14 +1370,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1638,14 +1396,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1660,14 +1422,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1682,14 +1448,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1704,14 +1474,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"CronJob"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1726,10 +1510,257 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlastscheduletime">getLastScheduleTime<a class="headerlink" href="#getlastscheduletime" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLastScheduleTime</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getschedule">getSchedule<a class="headerlink" href="#getschedule" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSchedule</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" 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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getsuspendflag">getSuspendFlag<a class="headerlink" href="#getsuspendflag" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSuspendFlag</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="isneverrun">isNeverRun<a class="headerlink" href="#isneverrun" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isNeverRun</strong>(): <code>boolean</code></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>boolean</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="issuspend">isSuspend<a class="headerlink" href="#issuspend" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isSuspend</strong>(): <code>undefined</code> | <code>boolean</code></p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>boolean</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>CronJob</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1047,69 +1110,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1153,8 +1153,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1186,15 +1195,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1247,281 +1247,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getaffinity">getAffinity<a class="headerlink" href="#getaffinity" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAffinity</strong>(): <code>undefined</code> | <code>Affinity</code></p>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>Affinity</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getaffinitynumber">getAffinityNumber<a class="headerlink" href="#getaffinitynumber" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAffinityNumber</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</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_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getimages">getImages<a class="headerlink" href="#getimages" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getImages</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</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>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getnodeselectors">getNodeSelectors<a class="headerlink" href="#getnodeselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNodeSelectors</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>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gettemplatelabels">getTemplateLabels<a class="headerlink" href="#gettemplatelabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getTemplateLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Toleration</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>DaemonSet</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1544,7 +1276,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1559,14 +1291,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1581,14 +1317,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1601,7 +1341,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1620,14 +1360,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1642,14 +1386,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1664,14 +1412,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1686,14 +1438,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1708,14 +1464,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1730,14 +1490,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1752,10 +1526,267 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getaffinity">getAffinity<a class="headerlink" href="#getaffinity" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAffinity</strong>(): <code>undefined</code> | <code>Affinity</code></p>
|
||||||
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>Affinity</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getaffinitynumber">getAffinityNumber<a class="headerlink" href="#getaffinitynumber" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAffinityNumber</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getimages">getImages<a class="headerlink" href="#getimages" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getImages</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getnodeselectors">getNodeSelectors<a class="headerlink" href="#getnodeselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNodeSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gettemplatelabels">getTemplateLabels<a class="headerlink" href="#gettemplatelabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getTemplateLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Toleration</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>DaemonSet</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -839,6 +839,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -853,6 +909,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1019,69 +1082,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1126,8 +1126,17 @@
|
|||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#subsets">subsets</a></li>
|
<li><a href="./#subsets">subsets</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1154,15 +1163,6 @@
|
|||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#tostring">toString</a></li>
|
<li><a href="./#tostring">toString</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1218,256 +1218,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getendpointsubsets">getEndpointSubsets<a class="headerlink" href="#getendpointsubsets" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getEndpointSubsets</strong>(): <code>Required</code><<code>EndpointSubset</code>>[]</p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Required</code><<code>EndpointSubset</code>>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" 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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="tostring">toString<a class="headerlink" href="#tostring" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>toString</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>Endpoint</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1490,7 +1247,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1505,14 +1262,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1527,14 +1288,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1547,7 +1312,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1566,14 +1331,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1588,14 +1357,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1610,14 +1383,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1632,14 +1409,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1654,14 +1435,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1676,14 +1461,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1698,10 +1497,242 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getendpointsubsets">getEndpointSubsets<a class="headerlink" href="#getendpointsubsets" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getEndpointSubsets</strong>(): <code>Required</code><<code>EndpointSubset</code>>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Required</code><<code>EndpointSubset</code>>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="tostring">toString<a class="headerlink" href="#tostring" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>toString</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>Endpoint</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1047,69 +1110,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1153,8 +1153,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1186,15 +1195,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1247,281 +1247,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"HorizontalPodAutoscaler"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getconditions">getConditions<a class="headerlink" href="#getconditions" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getConditions</strong>(): { <code>isReady</code>: <code>boolean</code> ; <code>lastTransitionTime?</code>: <code>string</code> ; <code>message?</code>: <code>string</code> ; <code>reason?</code>: <code>string</code> ; <code>status</code>: <code>"True"</code> | <code>"False"</code> | <code>"Unknown"</code> ; <code>tooltip</code>: <code>string</code> ; <code>type</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p>{ <code>isReady</code>: <code>boolean</code> ; <code>lastTransitionTime?</code>: <code>string</code> ; <code>message?</code>: <code>string</code> ; <code>reason?</code>: <code>string</code> ; <code>status</code>: <code>"True"</code> | <code>"False"</code> | <code>"Unknown"</code> ; <code>tooltip</code>: <code>string</code> ; <code>type</code>: <code>string</code> }[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcurrentmetrics">getCurrentMetrics<a class="headerlink" href="#getcurrentmetrics" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCurrentMetrics</strong>(): <code>HorizontalPodAutoscalerMetricStatus</code>[]</p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>HorizontalPodAutoscalerMetricStatus</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getmaxpods">getMaxPods<a class="headerlink" href="#getmaxpods" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMaxPods</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getmetrics">getMetrics<a class="headerlink" href="#getmetrics" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMetrics</strong>(): <code>HorizontalPodAutoscalerMetricSpec</code>[]</p>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>HorizontalPodAutoscalerMetricSpec</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getminpods">getMinPods<a class="headerlink" href="#getminpods" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMinPods</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getreadyconditions">getReadyConditions<a class="headerlink" href="#getreadyconditions" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getReadyConditions</strong>(): { <code>isReady</code>: <code>boolean</code> ; <code>lastTransitionTime?</code>: <code>string</code> ; <code>message?</code>: <code>string</code> ; <code>reason?</code>: <code>string</code> ; <code>status</code>: <code>"True"</code> | <code>"False"</code> | <code>"Unknown"</code> ; <code>tooltip</code>: <code>string</code> ; <code>type</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p>{ <code>isReady</code>: <code>boolean</code> ; <code>lastTransitionTime?</code>: <code>string</code> ; <code>message?</code>: <code>string</code> ; <code>reason?</code>: <code>string</code> ; <code>status</code>: <code>"True"</code> | <code>"False"</code> | <code>"Unknown"</code> ; <code>tooltip</code>: <code>string</code> ; <code>type</code>: <code>string</code> }[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getreplicas">getReplicas<a class="headerlink" href="#getreplicas" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getReplicas</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</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_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>HorizontalPodAutoscaler</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1544,7 +1276,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1559,14 +1291,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1581,14 +1317,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1601,7 +1341,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1620,14 +1360,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1642,14 +1386,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1664,14 +1412,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1686,14 +1438,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1708,14 +1464,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1730,14 +1490,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"HorizontalPodAutoscaler"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1752,10 +1526,267 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getconditions">getConditions<a class="headerlink" href="#getconditions" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getConditions</strong>(): { <code>isReady</code>: <code>boolean</code> ; <code>lastTransitionTime?</code>: <code>string</code> ; <code>message?</code>: <code>string</code> ; <code>reason?</code>: <code>string</code> ; <code>status</code>: <code>"True"</code> | <code>"False"</code> | <code>"Unknown"</code> ; <code>tooltip</code>: <code>string</code> ; <code>type</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p>{ <code>isReady</code>: <code>boolean</code> ; <code>lastTransitionTime?</code>: <code>string</code> ; <code>message?</code>: <code>string</code> ; <code>reason?</code>: <code>string</code> ; <code>status</code>: <code>"True"</code> | <code>"False"</code> | <code>"Unknown"</code> ; <code>tooltip</code>: <code>string</code> ; <code>type</code>: <code>string</code> }[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcurrentmetrics">getCurrentMetrics<a class="headerlink" href="#getcurrentmetrics" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCurrentMetrics</strong>(): <code>HorizontalPodAutoscalerMetricStatus</code>[]</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>HorizontalPodAutoscalerMetricStatus</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getmaxpods">getMaxPods<a class="headerlink" href="#getmaxpods" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMaxPods</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getmetrics">getMetrics<a class="headerlink" href="#getmetrics" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMetrics</strong>(): <code>HorizontalPodAutoscalerMetricSpec</code>[]</p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>HorizontalPodAutoscalerMetricSpec</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getminpods">getMinPods<a class="headerlink" href="#getminpods" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMinPods</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getreadyconditions">getReadyConditions<a class="headerlink" href="#getreadyconditions" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getReadyConditions</strong>(): { <code>isReady</code>: <code>boolean</code> ; <code>lastTransitionTime?</code>: <code>string</code> ; <code>message?</code>: <code>string</code> ; <code>reason?</code>: <code>string</code> ; <code>status</code>: <code>"True"</code> | <code>"False"</code> | <code>"Unknown"</code> ; <code>tooltip</code>: <code>string</code> ; <code>type</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p>{ <code>isReady</code>: <code>boolean</code> ; <code>lastTransitionTime?</code>: <code>string</code> ; <code>message?</code>: <code>string</code> ; <code>reason?</code>: <code>string</code> ; <code>status</code>: <code>"True"</code> | <code>"False"</code> | <code>"Unknown"</code> ; <code>tooltip</code>: <code>string</code> ; <code>type</code>: <code>string</code> }[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getreplicas">getReplicas<a class="headerlink" href="#getreplicas" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getReplicas</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</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_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>HorizontalPodAutoscaler</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1040,69 +1103,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1146,8 +1146,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1178,15 +1187,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1239,276 +1239,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Ingress"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gethosts">getHosts<a class="headerlink" href="#gethosts" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getHosts</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getloadbalancers">getLoadBalancers<a class="headerlink" href="#getloadbalancers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLoadBalancers</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getports">getPorts<a class="headerlink" href="#getports" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getPorts</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><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_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getroutes">getRoutes<a class="headerlink" href="#getroutes" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getRoutes</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getrules">getRules<a class="headerlink" href="#getrules" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getRules</strong>(): <code>IngressRule</code>[]</p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>IngressRule</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_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getservicenameport">getServiceNamePort<a class="headerlink" href="#getservicenameport" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getServiceNamePort</strong>(): <code>undefined</code> | <code>ExtensionsBackend</code></p>
|
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>ExtensionsBackend</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></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_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_22">Returns<a class="headerlink" href="#returns_22" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>Ingress</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1531,7 +1268,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1546,14 +1283,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1568,14 +1309,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1588,7 +1333,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1607,14 +1352,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1629,14 +1378,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1651,14 +1404,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1673,14 +1430,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1695,14 +1456,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1717,14 +1482,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Ingress"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1739,10 +1518,262 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gethosts">getHosts<a class="headerlink" href="#gethosts" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getHosts</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getloadbalancers">getLoadBalancers<a class="headerlink" href="#getloadbalancers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLoadBalancers</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getports">getPorts<a class="headerlink" href="#getports" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getPorts</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getroutes">getRoutes<a class="headerlink" href="#getroutes" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getRoutes</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getrules">getRules<a class="headerlink" href="#getrules" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getRules</strong>(): <code>IngressRule</code>[]</p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>IngressRule</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_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getservicenameport">getServiceNamePort<a class="headerlink" href="#getservicenameport" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getServiceNamePort</strong>(): <code>undefined</code> | <code>ExtensionsBackend</code></p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>ExtensionsBackend</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>Ingress</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1075,69 +1138,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1181,8 +1181,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1218,15 +1227,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1279,301 +1279,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Job"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getaffinity">getAffinity<a class="headerlink" href="#getaffinity" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAffinity</strong>(): <code>undefined</code> | <code>Affinity</code></p>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>Affinity</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getaffinitynumber">getAffinityNumber<a class="headerlink" href="#getaffinitynumber" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAffinityNumber</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</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_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcompletions">getCompletions<a class="headerlink" href="#getcompletions" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCompletions</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcondition">getCondition<a class="headerlink" href="#getcondition" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCondition</strong>(): <code>undefined</code> | <code>BaseKubeObjectCondition</code></p>
|
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>BaseKubeObjectCondition</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getdesiredcompletions">getDesiredCompletions<a class="headerlink" href="#getdesiredcompletions" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getDesiredCompletions</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</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>
|
|
||||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getimages">getImages<a class="headerlink" href="#getimages" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getImages</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getnodeselectors">getNodeSelectors<a class="headerlink" href="#getnodeselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNodeSelectors</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getparallelism">getParallelism<a class="headerlink" href="#getparallelism" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getParallelism</strong>(): <code>undefined</code> | <code>number</code></p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</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>string</code></p>
|
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gettemplatelabels">getTemplateLabels<a class="headerlink" href="#gettemplatelabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getTemplateLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_24">Returns<a class="headerlink" href="#returns_24" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Toleration</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_27">Returns<a class="headerlink" href="#returns_27" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>Job</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1596,7 +1308,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1611,14 +1323,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1633,14 +1349,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1653,7 +1373,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1672,14 +1392,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1694,14 +1418,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1716,14 +1444,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1738,14 +1470,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1760,14 +1496,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1782,14 +1522,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Job"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1804,10 +1558,287 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getaffinity">getAffinity<a class="headerlink" href="#getaffinity" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAffinity</strong>(): <code>undefined</code> | <code>Affinity</code></p>
|
||||||
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>Affinity</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getaffinitynumber">getAffinityNumber<a class="headerlink" href="#getaffinitynumber" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAffinityNumber</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcompletions">getCompletions<a class="headerlink" href="#getcompletions" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCompletions</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcondition">getCondition<a class="headerlink" href="#getcondition" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCondition</strong>(): <code>undefined</code> | <code>BaseKubeObjectCondition</code></p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>BaseKubeObjectCondition</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getdesiredcompletions">getDesiredCompletions<a class="headerlink" href="#getdesiredcompletions" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getDesiredCompletions</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getimages">getImages<a class="headerlink" href="#getimages" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getImages</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getnodeselectors">getNodeSelectors<a class="headerlink" href="#getnodeselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNodeSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getparallelism">getParallelism<a class="headerlink" href="#getparallelism" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getParallelism</strong>(): <code>undefined</code> | <code>number</code></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</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>string</code></p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gettemplatelabels">getTemplateLabels<a class="headerlink" href="#gettemplatelabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getTemplateLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Toleration</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>Job</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -930,6 +930,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -944,6 +1000,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1124,69 +1187,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1244,8 +1244,17 @@
|
|||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#type">type</a></li>
|
<li><a href="./#type">type</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1274,15 +1283,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1380,270 +1380,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfirstseentime">getFirstSeenTime<a class="headerlink" href="#getfirstseentime" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFirstSeenTime</strong>(): <code>string</code></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function is not reactive to changing of time. If rendering use <code><ReactiveDuration /></code> instead</p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlastseentime">getLastSeenTime<a class="headerlink" href="#getlastseentime" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLastSeenTime</strong>(): <code>string</code></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function is not reactive to changing of time. If rendering use <code><ReactiveDuration /></code> instead</p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</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>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getsource">getSource<a class="headerlink" href="#getsource" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSource</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="iswarning">isWarning<a class="headerlink" href="#iswarning" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isWarning</strong>(): <code>boolean</code></p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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>
|
|
||||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>KubeEvent</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1666,7 +1409,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1681,14 +1424,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1703,14 +1450,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1723,7 +1474,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1742,14 +1493,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1764,14 +1519,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1786,14 +1545,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1808,14 +1571,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1830,14 +1597,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1852,14 +1623,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1874,10 +1659,256 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfirstseentime">getFirstSeenTime<a class="headerlink" href="#getfirstseentime" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFirstSeenTime</strong>(): <code>string</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function is not reactive to changing of time. If rendering use <code><ReactiveDuration /></code> instead</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlastseentime">getLastSeenTime<a class="headerlink" href="#getlastseentime" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLastSeenTime</strong>(): <code>string</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function is not reactive to changing of time. If rendering use <code><ReactiveDuration /></code> instead</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" 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>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getsource">getSource<a class="headerlink" href="#getsource" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSource</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iswarning">isWarning<a class="headerlink" href="#iswarning" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isWarning</strong>(): <code>boolean</code></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" 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>
|
||||||
|
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>KubeEvent</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -846,6 +846,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -860,6 +916,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1012,69 +1075,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1174,8 +1174,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1200,15 +1209,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1270,210 +1270,13 @@
|
|||||||
<h3 id="apibase">apiBase<a class="headerlink" href="#apibase" title="Permanent link">#</a></h3>
|
<h3 id="apibase">apiBase<a class="headerlink" href="#apibase" title="Permanent link">#</a></h3>
|
||||||
<p>▪ <code>Static</code> <code>Optional</code> <code>Readonly</code> <strong>apiBase</strong>: <code>string</code></p>
|
<p>▪ <code>Static</code> <code>Optional</code> <code>Readonly</code> <strong>apiBase</strong>: <code>string</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Optional</code> <code>Readonly</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Optional</code> <code>Readonly</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="implementation-of">Implementation of<a class="headerlink" href="#implementation-of" title="Permanent link">#</a></h4>
|
|
||||||
<p>ItemObject.getId</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="implementation-of_1">Implementation of<a class="headerlink" href="#implementation-of_1" title="Permanent link">#</a></h4>
|
|
||||||
<p>ItemObject.getName</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>Metadata</code>[<code>"namespace"</code>]</p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Metadata</code>[<code>"namespace"</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>Metadata</code>[<code>"namespace"</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>Metadata</code>[<code>"namespace"</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="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>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getsearchfields">getSearchFields<a class="headerlink" href="#getsearchfields" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSearchFields</strong>(): (<code>string</code> | <code>Metadata</code>[<code>"namespace"</code>])[]</p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>string</code> | <code>Metadata</code>[<code>"namespace"</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></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_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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</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>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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>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>
|
|
||||||
</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="./"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="./"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="./"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1496,7 +1299,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1511,12 +1314,16 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="./"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="./"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1531,12 +1338,16 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_3">Type parameters<a class="headerlink" href="#type-parameters_3" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_3">Type parameters<a class="headerlink" href="#type-parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1549,7 +1360,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1568,12 +1379,16 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1588,12 +1403,16 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1608,12 +1427,16 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="./"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1628,12 +1451,16 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1648,12 +1475,16 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1668,12 +1499,22 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Optional</code> <code>Readonly</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Optional</code> <code>Readonly</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="./#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1688,8 +1529,198 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="implementation-of">Implementation of<a class="headerlink" href="#implementation-of" title="Permanent link">#</a></h4>
|
||||||
|
<p>ItemObject.getId</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="implementation-of_1">Implementation of<a class="headerlink" href="#implementation-of_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>ItemObject.getName</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>Metadata</code>[<code>"namespace"</code>]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Metadata</code>[<code>"namespace"</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>Metadata</code>[<code>"namespace"</code>] ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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>Metadata</code>[<code>"namespace"</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_20">Returns<a class="headerlink" href="#returns_20" 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_21">Returns<a class="headerlink" href="#returns_21" 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> | <code>Metadata</code>[<code>"namespace"</code>])[]</p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>string</code> | <code>Metadata</code>[<code>"namespace"</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="./#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" 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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -910,13 +910,13 @@
|
|||||||
<p>• <code>Readonly</code> <strong>kind</strong>: <code>"Status"</code></p>
|
<p>• <code>Readonly</code> <strong>kind</strong>: <code>"Status"</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="message">message<a class="headerlink" href="#message" title="Permanent link">#</a></h3>
|
<h3 id="message">message<a class="headerlink" href="#message" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>Optional</code> <code>Readonly</code> <strong>message</strong>: <code>string</code></p>
|
<p>• <code>Readonly</code> <strong>message</strong>: <code>string</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="reason">reason<a class="headerlink" href="#reason" title="Permanent link">#</a></h3>
|
<h3 id="reason">reason<a class="headerlink" href="#reason" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>Optional</code> <code>Readonly</code> <strong>reason</strong>: <code>string</code></p>
|
<p>• <code>Readonly</code> <strong>reason</strong>: <code>string</code></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>Optional</code> <code>Readonly</code> <strong>status</strong>: <code>string</code></p>
|
<p>• <code>Readonly</code> <strong>status</strong>: <code>string</code></p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="getexplanation">getExplanation<a class="headerlink" href="#getexplanation" title="Permanent link">#</a></h3>
|
<h3 id="getexplanation">getExplanation<a class="headerlink" href="#getexplanation" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getExplanation</strong>(): <code>string</code></p>
|
<p>▸ <strong>getExplanation</strong>(): <code>string</code></p>
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1019,69 +1082,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1125,8 +1125,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1154,15 +1163,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1215,261 +1215,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"LimitRange"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcontainerlimits">getContainerLimits<a class="headerlink" href="#getcontainerlimits" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getContainerLimits</strong>(): <code>LimitRangeItem</code>[]</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>LimitRangeItem</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getpvclimits">getPVCLimits<a class="headerlink" href="#getpvclimits" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getPVCLimits</strong>(): <code>LimitRangeItem</code>[]</p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>LimitRangeItem</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getpodlimits">getPodLimits<a class="headerlink" href="#getpodlimits" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getPodLimits</strong>(): <code>LimitRangeItem</code>[]</p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>LimitRangeItem</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_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>LimitRange</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1492,7 +1244,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1507,14 +1259,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1529,14 +1285,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1549,7 +1309,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1568,14 +1328,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1590,14 +1354,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1612,14 +1380,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1634,14 +1406,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1656,14 +1432,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1678,14 +1458,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"LimitRange"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1700,10 +1494,247 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcontainerlimits">getContainerLimits<a class="headerlink" href="#getcontainerlimits" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getContainerLimits</strong>(): <code>LimitRangeItem</code>[]</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>LimitRangeItem</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getpvclimits">getPVCLimits<a class="headerlink" href="#getpvclimits" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getPVCLimits</strong>(): <code>LimitRangeItem</code>[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>LimitRangeItem</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getpodlimits">getPodLimits<a class="headerlink" href="#getpodlimits" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getPodLimits</strong>(): <code>LimitRangeItem</code>[]</p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>LimitRangeItem</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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>LimitRange</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1026,69 +1089,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1132,8 +1132,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1162,15 +1171,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1223,281 +1223,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Namespace"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>false</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getstatus">getStatus<a class="headerlink" href="#getstatus" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getStatus</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="ischildof">isChildOf<a class="headerlink" href="#ischildof" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isChildOf</strong>(<code>parentName</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>parentName</code></td>
|
|
||||||
<td align="left"><code>string</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="iscontrolledbyhnc">isControlledByHNC<a class="headerlink" href="#iscontrolledbyhnc" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isControlledByHNC</strong>(): <code>boolean</code></p>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>boolean</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="issubnamespace">isSubnamespace<a class="headerlink" href="#issubnamespace" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isSubnamespace</strong>(): <code>undefined</code> | <code>string</code></p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>string</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>Namespace</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1520,7 +1252,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1535,14 +1267,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1557,14 +1293,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1577,7 +1317,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1596,14 +1336,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1618,14 +1362,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1640,14 +1388,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1662,14 +1414,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1684,14 +1440,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1706,14 +1466,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Namespace"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>false</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1728,10 +1502,267 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code></p>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getstatus">getStatus<a class="headerlink" href="#getstatus" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getStatus</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="ischildof">isChildOf<a class="headerlink" href="#ischildof" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isChildOf</strong>(<code>parentName</code>): <code>undefined</code> | <code>string</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>parentName</code></td>
|
||||||
|
<td align="left"><code>string</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iscontrolledbyhnc">isControlledByHNC<a class="headerlink" href="#iscontrolledbyhnc" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isControlledByHNC</strong>(): <code>boolean</code></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>boolean</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="issubnamespace">isSubnamespace<a class="headerlink" href="#issubnamespace" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isSubnamespace</strong>(): <code>undefined</code> | <code>string</code></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>string</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>data</code></td>
|
||||||
|
<td align="left"><code>Partial</code><<a href="./"><code>Namespace</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1012,69 +1075,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1118,8 +1118,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1146,15 +1155,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1207,256 +1207,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"NetworkPolicy"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getmatchlabels">getMatchLabels<a class="headerlink" href="#getmatchlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMatchLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_13">Returns<a class="headerlink" href="#returns_13" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gettypes">getTypes<a class="headerlink" href="#gettypes" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getTypes</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>NetworkPolicy</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1479,7 +1236,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1494,14 +1251,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1516,14 +1277,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1536,7 +1301,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1555,14 +1320,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1577,14 +1346,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1599,14 +1372,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1621,14 +1398,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1643,14 +1424,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1665,14 +1450,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"NetworkPolicy"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1687,10 +1486,242 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getmatchlabels">getMatchLabels<a class="headerlink" href="#getmatchlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMatchLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gettypes">getTypes<a class="headerlink" href="#gettypes" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getTypes</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>NetworkPolicy</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1089,69 +1152,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1195,8 +1195,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1234,15 +1243,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1295,313 +1295,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Node"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>false</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getactiveconditions">getActiveConditions<a class="headerlink" href="#getactiveconditions" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getActiveConditions</strong>(): <code>NodeCondition</code>[]</p>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>NodeCondition</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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></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_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getconditions">getConditions<a class="headerlink" href="#getconditions" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getConditions</strong>(): <code>NodeCondition</code>[]</p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>NodeCondition</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcpucapacity">getCpuCapacity<a class="headerlink" href="#getcpucapacity" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCpuCapacity</strong>(): <code>undefined</code> | <code>number</code></p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getkubeletversion">getKubeletVersion<a class="headerlink" href="#getkubeletversion" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getKubeletVersion</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</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>
|
|
||||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getmemorycapacity">getMemoryCapacity<a class="headerlink" href="#getmemorycapacity" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMemoryCapacity</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getnodeconditiontext">getNodeConditionText<a class="headerlink" href="#getnodeconditiontext" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNodeConditionText</strong>(): <code>string</code></p>
|
|
||||||
<p>Returns the concatination of all current condition types which have a status
|
|
||||||
of <code>"True"</code></p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getoperatingsystem">getOperatingSystem<a class="headerlink" href="#getoperatingsystem" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getOperatingSystem</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getrolelabelitems">getRoleLabelItems<a class="headerlink" href="#getrolelabelitems" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getRoleLabelItems</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getrolelabels">getRoleLabels<a class="headerlink" href="#getrolelabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getRoleLabels</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gettaints">getTaints<a class="headerlink" href="#gettaints" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getTaints</strong>(): <code>NodeTaint</code>[]</p>
|
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>NodeTaint</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></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_24">Returns<a class="headerlink" href="#returns_24" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getwarningconditions">getWarningConditions<a class="headerlink" href="#getwarningconditions" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getWarningConditions</strong>(): <code>NodeCondition</code>[]</p>
|
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>NodeCondition</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="ismasternode">isMasterNode<a class="headerlink" href="#ismasternode" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isMasterNode</strong>(): <code>boolean</code></p>
|
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>boolean</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="isunschedulable">isUnschedulable<a class="headerlink" href="#isunschedulable" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isUnschedulable</strong>(): <code>undefined</code> | <code>boolean</code></p>
|
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>boolean</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_29">Returns<a class="headerlink" href="#returns_29" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>Node</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1624,7 +1324,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1639,14 +1339,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1661,14 +1365,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1681,7 +1389,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1700,14 +1408,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1722,14 +1434,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1744,14 +1460,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1766,14 +1486,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1788,14 +1512,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1810,14 +1538,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Node"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>false</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1832,10 +1574,299 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_39">Returns<a class="headerlink" href="#returns_39" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getactiveconditions">getActiveConditions<a class="headerlink" href="#getactiveconditions" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getActiveConditions</strong>(): <code>NodeCondition</code>[]</p>
|
||||||
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>NodeCondition</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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getconditions">getConditions<a class="headerlink" href="#getconditions" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getConditions</strong>(): <code>NodeCondition</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>NodeCondition</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcpucapacity">getCpuCapacity<a class="headerlink" href="#getcpucapacity" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCpuCapacity</strong>(): <code>undefined</code> | <code>number</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getkubeletversion">getKubeletVersion<a class="headerlink" href="#getkubeletversion" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getKubeletVersion</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getmemorycapacity">getMemoryCapacity<a class="headerlink" href="#getmemorycapacity" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMemoryCapacity</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getnodeconditiontext">getNodeConditionText<a class="headerlink" href="#getnodeconditiontext" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNodeConditionText</strong>(): <code>string</code></p>
|
||||||
|
<p>Returns the concatination of all current condition types which have a status
|
||||||
|
of <code>"True"</code></p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code></p>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getoperatingsystem">getOperatingSystem<a class="headerlink" href="#getoperatingsystem" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getOperatingSystem</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" 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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getrolelabelitems">getRoleLabelItems<a class="headerlink" href="#getrolelabelitems" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getRoleLabelItems</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getrolelabels">getRoleLabels<a class="headerlink" href="#getrolelabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getRoleLabels</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_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gettaints">getTaints<a class="headerlink" href="#gettaints" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getTaints</strong>(): <code>NodeTaint</code>[]</p>
|
||||||
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>NodeTaint</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getwarningconditions">getWarningConditions<a class="headerlink" href="#getwarningconditions" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getWarningConditions</strong>(): <code>NodeCondition</code>[]</p>
|
||||||
|
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>NodeCondition</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="ismasternode">isMasterNode<a class="headerlink" href="#ismasternode" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isMasterNode</strong>(): <code>boolean</code></p>
|
||||||
|
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>boolean</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="isunschedulable">isUnschedulable<a class="headerlink" href="#isunschedulable" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isUnschedulable</strong>(): <code>undefined</code> | <code>boolean</code></p>
|
||||||
|
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>boolean</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>Node</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_39">Returns<a class="headerlink" href="#returns_39" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1033,69 +1096,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1139,8 +1139,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1170,15 +1179,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1231,286 +1231,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcapacity">getCapacity<a class="headerlink" href="#getcapacity" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCapacity</strong>(<code>inBytes?</code>): <code>string</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>inBytes?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getclaimrefname">getClaimRefName<a class="headerlink" href="#getclaimrefname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getClaimRefName</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getstatus">getStatus<a class="headerlink" href="#getstatus" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getStatus</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getstorageclass">getStorageClass<a class="headerlink" href="#getstorageclass" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getStorageClass</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getstorageclassname">getStorageClassName<a class="headerlink" href="#getstorageclassname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getStorageClassName</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>PersistentVolume</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1533,7 +1260,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1548,14 +1275,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1570,14 +1301,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1590,7 +1325,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1609,14 +1344,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1631,14 +1370,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1653,14 +1396,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1675,14 +1422,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1697,14 +1448,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1719,14 +1474,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1741,10 +1510,272 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcapacity">getCapacity<a class="headerlink" href="#getcapacity" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCapacity</strong>(<code>inBytes?</code>): <code>string</code> | <code>number</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>inBytes?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code> | <code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getclaimrefname">getClaimRefName<a class="headerlink" href="#getclaimrefname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getClaimRefName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code></p>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" 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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getstatus">getStatus<a class="headerlink" href="#getstatus" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getStatus</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getstorageclass">getStorageClass<a class="headerlink" href="#getstorageclass" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getStorageClass</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getstorageclassname">getStorageClassName<a class="headerlink" href="#getstorageclassname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getStorageClassName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>data</code></td>
|
||||||
|
<td align="left"><code>Partial</code><<a href="./"><code>PersistentVolume</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1033,69 +1096,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1139,8 +1139,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1170,15 +1179,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1231,286 +1231,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"PersistentVolumeClaim"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getmatchexpressions">getMatchExpressions<a class="headerlink" href="#getmatchexpressions" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMatchExpressions</strong>(): <code>LabelMatchExpression</code>[]</p>
|
|
||||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>LabelMatchExpression</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getmatchlabels">getMatchLabels<a class="headerlink" href="#getmatchlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMatchLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getpods">getPods<a class="headerlink" href="#getpods" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getPods</strong>(<code>pods</code>): <a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</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>pods</code></td>
|
|
||||||
<td align="left"><a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</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_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getstatus">getStatus<a class="headerlink" href="#getstatus" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getStatus</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getstorage">getStorage<a class="headerlink" href="#getstorage" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getStorage</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>PersistentVolumeClaim</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1533,7 +1260,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1548,14 +1275,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1570,14 +1301,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1590,7 +1325,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1609,14 +1344,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1631,14 +1370,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1653,14 +1396,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1675,14 +1422,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1697,14 +1448,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1719,14 +1474,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"PersistentVolumeClaim"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1741,10 +1510,272 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getmatchexpressions">getMatchExpressions<a class="headerlink" href="#getmatchexpressions" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMatchExpressions</strong>(): <code>LabelMatchExpression</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>LabelMatchExpression</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getmatchlabels">getMatchLabels<a class="headerlink" href="#getmatchlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMatchLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getpods">getPods<a class="headerlink" href="#getpods" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getPods</strong>(<code>pods</code>): <a href="../Main.K8sApi.Pod/"><code>Pod</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>pods</code></td>
|
||||||
|
<td align="left"><a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getstatus">getStatus<a class="headerlink" href="#getstatus" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getStatus</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getstorage">getStorage<a class="headerlink" href="#getstorage" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getStorage</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>data</code></td>
|
||||||
|
<td align="left"><code>Partial</code><<a href="./"><code>PersistentVolumeClaim</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1033,69 +1096,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1139,8 +1139,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1170,15 +1179,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1231,271 +1231,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"PodDisruptionBudget"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcurrenthealthy">getCurrentHealthy<a class="headerlink" href="#getcurrenthealthy" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCurrentHealthy</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getdesiredhealthy">getDesiredHealthy<a class="headerlink" href="#getdesiredhealthy" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getDesiredHealthy</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getmaxunavailable">getMaxUnavailable<a class="headerlink" href="#getmaxunavailable" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMaxUnavailable</strong>(): <code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getminavailable">getMinAvailable<a class="headerlink" href="#getminavailable" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getMinAvailable</strong>(): <code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</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>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>PodDisruptionBudget</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1518,7 +1260,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1533,14 +1275,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1555,14 +1301,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1575,7 +1325,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1594,14 +1344,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1616,14 +1370,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1638,14 +1396,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1660,14 +1422,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1682,14 +1448,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1704,14 +1474,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"PodDisruptionBudget"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1726,10 +1510,257 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcurrenthealthy">getCurrentHealthy<a class="headerlink" href="#getcurrenthealthy" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCurrentHealthy</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getdesiredhealthy">getDesiredHealthy<a class="headerlink" href="#getdesiredhealthy" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getDesiredHealthy</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getmaxunavailable">getMaxUnavailable<a class="headerlink" href="#getmaxunavailable" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMaxUnavailable</strong>(): <code>string</code> | <code>number</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code> | <code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getminavailable">getMinAvailable<a class="headerlink" href="#getminavailable" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getMinAvailable</strong>(): <code>string</code> | <code>number</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code> | <code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>PodDisruptionBudget</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -860,6 +860,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -874,6 +930,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1054,69 +1117,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1164,8 +1164,17 @@
|
|||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#value">value</a></li>
|
<li><a href="./#value">value</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1194,15 +1203,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1267,266 +1267,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"PriorityClass"</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>false</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getdescription">getDescription<a class="headerlink" href="#getdescription" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getDescription</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getglobaldefault">getGlobalDefault<a class="headerlink" href="#getglobaldefault" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getGlobalDefault</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getpreemptionpolicy">getPreemptionPolicy<a class="headerlink" href="#getpreemptionpolicy" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getPreemptionPolicy</strong>(): <code>PreemptionPolicy</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>PreemptionPolicy</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_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getvalue">getValue<a class="headerlink" href="#getvalue" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getValue</strong>(): <code>undefined</code> | <code>number</code></p>
|
|
||||||
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>PriorityClass</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1549,7 +1296,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1564,14 +1311,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1586,14 +1337,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1606,7 +1361,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1625,14 +1380,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1647,14 +1406,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1669,14 +1432,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1691,14 +1458,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1713,14 +1484,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1735,14 +1510,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"PriorityClass"</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>false</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1757,10 +1546,252 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getdescription">getDescription<a class="headerlink" href="#getdescription" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getDescription</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getglobaldefault">getGlobalDefault<a class="headerlink" href="#getglobaldefault" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getGlobalDefault</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code></p>
|
||||||
|
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" 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>undefined</code> ; <code>uid</code>: <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getpreemptionpolicy">getPreemptionPolicy<a class="headerlink" href="#getpreemptionpolicy" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getPreemptionPolicy</strong>(): <code>PreemptionPolicy</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>PreemptionPolicy</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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getvalue">getValue<a class="headerlink" href="#getvalue" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getValue</strong>(): <code>undefined</code> | <code>number</code></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>PriorityClass</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1068,69 +1131,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1174,8 +1174,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1210,15 +1219,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1271,296 +1271,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getaffinity">getAffinity<a class="headerlink" href="#getaffinity" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAffinity</strong>(): <code>undefined</code> | <code>Affinity</code></p>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>Affinity</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getaffinitynumber">getAffinityNumber<a class="headerlink" href="#getaffinitynumber" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAffinityNumber</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</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_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcurrent">getCurrent<a class="headerlink" href="#getcurrent" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCurrent</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getdesired">getDesired<a class="headerlink" href="#getdesired" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getDesired</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getimages">getImages<a class="headerlink" href="#getimages" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getImages</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</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>
|
|
||||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getnodeselectors">getNodeSelectors<a class="headerlink" href="#getnodeselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNodeSelectors</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getready">getReady<a class="headerlink" href="#getready" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getReady</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</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_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gettemplatelabels">getTemplateLabels<a class="headerlink" href="#gettemplatelabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getTemplateLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_23">Returns<a class="headerlink" href="#returns_23" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Toleration</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_26">Returns<a class="headerlink" href="#returns_26" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>ReplicaSet</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1583,7 +1300,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1598,14 +1315,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1620,14 +1341,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1640,7 +1365,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1659,14 +1384,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1681,14 +1410,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1703,14 +1436,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1725,14 +1462,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1747,14 +1488,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1769,14 +1514,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>kind</strong>: <code>string</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <strong>namespaced</strong>: <code>boolean</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1791,10 +1550,282 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getaffinity">getAffinity<a class="headerlink" href="#getaffinity" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAffinity</strong>(): <code>undefined</code> | <code>Affinity</code></p>
|
||||||
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>Affinity</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getaffinitynumber">getAffinityNumber<a class="headerlink" href="#getaffinitynumber" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAffinityNumber</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcurrent">getCurrent<a class="headerlink" href="#getcurrent" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCurrent</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getdesired">getDesired<a class="headerlink" href="#getdesired" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getDesired</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getimages">getImages<a class="headerlink" href="#getimages" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getImages</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getnodeselectors">getNodeSelectors<a class="headerlink" href="#getnodeselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNodeSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getready">getReady<a class="headerlink" href="#getready" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getReady</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</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_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gettemplatelabels">getTemplateLabels<a class="headerlink" href="#gettemplatelabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getTemplateLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Toleration</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>ReplicaSet</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1005,69 +1068,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1111,8 +1111,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1138,15 +1147,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1199,251 +1199,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"ResourceQuota"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getscopeselector">getScopeSelector<a class="headerlink" href="#getscopeselector" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getScopeSelector</strong>(): { <code>operator</code>: <code>string</code> ; <code>scopeName</code>: <code>string</code> ; <code>values</code>: <code>string</code>[] }[]</p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p>{ <code>operator</code>: <code>string</code> ; <code>scopeName</code>: <code>string</code> ; <code>values</code>: <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_13">Returns<a class="headerlink" href="#returns_13" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>ResourceQuota</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1466,7 +1228,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1481,14 +1243,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1503,14 +1269,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1523,7 +1293,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1542,14 +1312,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1564,14 +1338,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1586,14 +1364,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1608,14 +1390,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1630,14 +1416,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1652,14 +1442,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"ResourceQuota"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1674,10 +1478,237 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getscopeselector">getScopeSelector<a class="headerlink" href="#getscopeselector" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getScopeSelector</strong>(): { <code>operator</code>: <code>string</code> ; <code>scopeName</code>: <code>string</code> ; <code>values</code>: <code>string</code>[] }[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p>{ <code>operator</code>: <code>string</code> ; <code>scopeName</code>: <code>string</code> ; <code>values</code>: <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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>ResourceQuota</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -839,6 +839,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -853,6 +909,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1012,69 +1075,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1119,8 +1119,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1146,15 +1155,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1210,251 +1210,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Role"</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getrules">getRules<a class="headerlink" href="#getrules" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getRules</strong>(): <code>PolicyRule</code>[]</p>
|
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>PolicyRule</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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>Role</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1477,7 +1239,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1492,14 +1254,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1514,14 +1280,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1534,7 +1304,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1553,14 +1323,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1575,14 +1349,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1597,14 +1375,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1619,14 +1401,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1641,14 +1427,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1663,14 +1453,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Role"</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1685,10 +1489,237 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getrules">getRules<a class="headerlink" href="#getrules" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getRules</strong>(): <code>PolicyRule</code>[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>PolicyRule</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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>Role</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -846,6 +846,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -860,6 +916,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1026,69 +1089,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1134,8 +1134,17 @@
|
|||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#subjects">subjects</a></li>
|
<li><a href="./#subjects">subjects</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1162,15 +1171,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1229,256 +1229,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"RoleBinding"</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_13">Returns<a class="headerlink" href="#returns_13" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getsubjectnames">getSubjectNames<a class="headerlink" href="#getsubjectnames" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSubjectNames</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getsubjects">getSubjects<a class="headerlink" href="#getsubjects" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSubjects</strong>(): <code>Subject</code>[]</p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Subject</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></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_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>RoleBinding</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1501,7 +1258,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1516,14 +1273,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1538,14 +1299,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1558,7 +1323,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1577,14 +1342,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1599,14 +1368,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1621,14 +1394,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1643,14 +1420,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1665,14 +1446,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1687,14 +1472,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"RoleBinding"</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1709,10 +1508,242 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getsubjectnames">getSubjectNames<a class="headerlink" href="#getsubjectnames" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSubjectNames</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getsubjects">getSubjects<a class="headerlink" href="#getsubjects" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSubjects</strong>(): <code>Subject</code>[]</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Subject</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>RoleBinding</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -846,6 +846,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -860,6 +916,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1026,69 +1089,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1134,8 +1134,17 @@
|
|||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#type">type</a></li>
|
<li><a href="./#type">type</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1162,15 +1171,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1229,256 +1229,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Secret"</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getkeys">getKeys<a class="headerlink" href="#getkeys" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getKeys</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" 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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gettoken">getToken<a class="headerlink" href="#gettoken" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getToken</strong>(): <code>undefined</code> | <code>string</code></p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | <code>string</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>Secret</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1501,7 +1258,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1516,14 +1273,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1538,14 +1299,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1558,7 +1323,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1577,14 +1342,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1599,14 +1368,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1621,14 +1394,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1643,14 +1420,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1665,14 +1446,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1687,14 +1472,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Secret"</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1709,10 +1508,242 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getkeys">getKeys<a class="headerlink" href="#getkeys" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getKeys</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gettoken">getToken<a class="headerlink" href="#gettoken" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getToken</strong>(): <code>undefined</code> | <code>string</code></p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | <code>string</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>Secret</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1075,69 +1138,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1181,8 +1181,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1218,15 +1227,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1279,301 +1279,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Service"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getclusterip">getClusterIp<a class="headerlink" href="#getclusterip" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getClusterIp</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getclusterips">getClusterIps<a class="headerlink" href="#getclusterips" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getClusterIps</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getexternalips">getExternalIps<a class="headerlink" href="#getexternalips" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getExternalIps</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<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="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getipfamilies">getIpFamilies<a class="headerlink" href="#getipfamilies" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getIpFamilies</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getipfamilypolicy">getIpFamilyPolicy<a class="headerlink" href="#getipfamilypolicy" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getIpFamilyPolicy</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="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</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>
|
|
||||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getloadbalancer">getLoadBalancer<a class="headerlink" href="#getloadbalancer" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLoadBalancer</strong>(): <code>undefined</code> | { <code>ingress?</code>: { <code>hostname?</code>: <code>string</code> ; <code>ip?</code>: <code>string</code> }[] }</p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code> | { <code>ingress?</code>: { <code>hostname?</code>: <code>string</code> ; <code>ip?</code>: <code>string</code> }[] }</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getports">getPorts<a class="headerlink" href="#getports" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getPorts</strong>(): <code>ServicePort</code>[]</p>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>ServicePort</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_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getselector">getSelector<a class="headerlink" href="#getselector" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSelector</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" 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>"Active"</code> | <code>"Pending"</code></p>
|
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>"Active"</code> | <code>"Pending"</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></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_23">Returns<a class="headerlink" href="#returns_23" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gettype">getType<a class="headerlink" href="#gettype" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getType</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="isactive">isActive<a class="headerlink" href="#isactive" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isActive</strong>(): <code>boolean</code></p>
|
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" 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>
|
|
||||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_27">Returns<a class="headerlink" href="#returns_27" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>Service</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1596,7 +1308,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1611,14 +1323,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1633,14 +1349,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1653,7 +1373,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1672,14 +1392,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1694,14 +1418,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1716,14 +1444,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1738,14 +1470,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1760,14 +1496,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1782,14 +1522,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"Service"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1804,10 +1558,287 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getclusterip">getClusterIp<a class="headerlink" href="#getclusterip" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getClusterIp</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getclusterips">getClusterIps<a class="headerlink" href="#getclusterips" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getClusterIps</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getexternalips">getExternalIps<a class="headerlink" href="#getexternalips" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getExternalIps</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getipfamilies">getIpFamilies<a class="headerlink" href="#getipfamilies" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getIpFamilies</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getipfamilypolicy">getIpFamilyPolicy<a class="headerlink" href="#getipfamilypolicy" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getIpFamilyPolicy</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getloadbalancer">getLoadBalancer<a class="headerlink" href="#getloadbalancer" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLoadBalancer</strong>(): <code>undefined</code> | { <code>ingress?</code>: { <code>hostname?</code>: <code>string</code> ; <code>ip?</code>: <code>string</code> }[] }</p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code> | { <code>ingress?</code>: { <code>hostname?</code>: <code>string</code> ; <code>ip?</code>: <code>string</code> }[] }</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getports">getPorts<a class="headerlink" href="#getports" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getPorts</strong>(): <code>ServicePort</code>[]</p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>ServicePort</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_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getselector">getSelector<a class="headerlink" href="#getselector" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSelector</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" 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>"Active"</code> | <code>"Pending"</code></p>
|
||||||
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>"Active"</code> | <code>"Pending"</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gettype">getType<a class="headerlink" href="#gettype" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getType</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="isactive">isActive<a class="headerlink" href="#isactive" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isActive</strong>(): <code>boolean</code></p>
|
||||||
|
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" 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>
|
||||||
|
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>Service</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -853,6 +853,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -867,6 +923,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1033,69 +1096,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1142,8 +1142,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1170,15 +1179,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1240,256 +1240,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"ServiceAccount"</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getimagepullsecrets">getImagePullSecrets<a class="headerlink" href="#getimagepullsecrets" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getImagePullSecrets</strong>(): <code>LocalObjectReference</code>[]</p>
|
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>LocalObjectReference</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" 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>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>ObjectReference</code>[]</p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>ObjectReference</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></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_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>ServiceAccount</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1512,7 +1269,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1527,14 +1284,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1549,14 +1310,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1569,7 +1334,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1588,14 +1353,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1610,14 +1379,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1632,14 +1405,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1654,14 +1431,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1676,14 +1457,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1698,14 +1483,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"ServiceAccount"</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1720,10 +1519,242 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getimagepullsecrets">getImagePullSecrets<a class="headerlink" href="#getimagepullsecrets" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getImagePullSecrets</strong>(): <code>LocalObjectReference</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>LocalObjectReference</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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>
|
||||||
|
<h4 id="inherited-from_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>ObjectReference</code>[]</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>ObjectReference</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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>ServiceAccount</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -832,6 +832,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,6 +902,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1054,69 +1117,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1160,8 +1160,17 @@
|
|||||||
<li><a href="./#spec">spec</a></li>
|
<li><a href="./#spec">spec</a></li>
|
||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1194,15 +1203,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1255,286 +1255,13 @@
|
|||||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"StatefulSet"</code></p>
|
|
||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getaffinity">getAffinity<a class="headerlink" href="#getaffinity" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAffinity</strong>(): <code>Affinity</code></p>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Affinity</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getaffinitynumber">getAffinityNumber<a class="headerlink" href="#getaffinitynumber" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAffinityNumber</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</code>[]</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</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_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getimages">getImages<a class="headerlink" href="#getimages" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getImages</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</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>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getnodeselectors">getNodeSelectors<a class="headerlink" href="#getnodeselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNodeSelectors</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>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getreplicas">getReplicas<a class="headerlink" href="#getreplicas" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getReplicas</strong>(): <code>number</code></p>
|
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</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_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_18">Returns<a class="headerlink" href="#returns_18" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="gettemplatelabels">getTemplateLabels<a class="headerlink" href="#gettemplatelabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getTemplateLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</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></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_21">Returns<a class="headerlink" href="#returns_21" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Toleration</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_24">Returns<a class="headerlink" href="#returns_24" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>StatefulSet</code></a>></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1557,7 +1284,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1572,14 +1299,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1594,14 +1325,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<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>
|
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1614,7 +1349,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1633,14 +1368,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<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>
|
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1655,14 +1394,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1677,14 +1420,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<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>
|
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1699,14 +1446,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</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>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1721,14 +1472,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1743,14 +1498,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<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>
|
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"StatefulSet"</code></p>
|
||||||
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>true</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1765,10 +1534,272 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</code>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>void</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getaffinity">getAffinity<a class="headerlink" href="#getaffinity" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAffinity</strong>(): <code>Affinity</code></p>
|
||||||
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Affinity</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getaffinitynumber">getAffinityNumber<a class="headerlink" href="#getaffinitynumber" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAffinityNumber</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getimages">getImages<a class="headerlink" href="#getimages" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getImages</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getnodeselectors">getNodeSelectors<a class="headerlink" href="#getnodeselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNodeSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" 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>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getreplicas">getReplicas<a class="headerlink" href="#getreplicas" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getReplicas</strong>(): <code>number</code></p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</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_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getselectors">getSelectors<a class="headerlink" href="#getselectors" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getSelectors</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="gettemplatelabels">getTemplateLabels<a class="headerlink" href="#gettemplatelabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getTemplateLabels</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="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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Toleration</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>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>Partial</code><<a href="./"><code>StatefulSet</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -881,6 +881,62 @@
|
|||||||
apiBase
|
apiBase
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#create" class="md-nav__link">
|
||||||
|
create
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isnonsystem" class="md-nav__link">
|
||||||
|
isNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -895,6 +951,13 @@
|
|||||||
namespaced
|
namespaced
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1068,69 +1131,6 @@
|
|||||||
update
|
update
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#create" class="md-nav__link">
|
|
||||||
create
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidata" class="md-nav__link">
|
|
||||||
isJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isjsonapidatalist" class="md-nav__link">
|
|
||||||
isJsonApiDataList
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiListMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
|
||||||
isKubeJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#isnonsystem" class="md-nav__link">
|
|
||||||
isNonSystem
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapidata" class="md-nav__link">
|
|
||||||
isPartialJsonApiData
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
|
||||||
isPartialJsonApiMetadata
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#stringifylabels" class="md-nav__link">
|
|
||||||
stringifyLabels
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1181,8 +1181,17 @@
|
|||||||
<li><a href="./#status">status</a></li>
|
<li><a href="./#status">status</a></li>
|
||||||
<li><a href="./#volumebindingmode">volumeBindingMode</a></li>
|
<li><a href="./#volumebindingmode">volumeBindingMode</a></li>
|
||||||
<li><a href="./#apibase">apiBase</a></li>
|
<li><a href="./#apibase">apiBase</a></li>
|
||||||
|
<li><a href="./#create">create</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
<li><a href="./#kind-1">kind</a></li>
|
<li><a href="./#kind-1">kind</a></li>
|
||||||
<li><a href="./#namespaced">namespaced</a></li>
|
<li><a href="./#namespaced">namespaced</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1210,15 +1219,6 @@
|
|||||||
<li><a href="./#patch">patch</a></li>
|
<li><a href="./#patch">patch</a></li>
|
||||||
<li><a href="./#toplainobject">toPlainObject</a></li>
|
<li><a href="./#toplainobject">toPlainObject</a></li>
|
||||||
<li><a href="./#update">update</a></li>
|
<li><a href="./#update">update</a></li>
|
||||||
<li><a href="./#create">create</a></li>
|
|
||||||
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
|
||||||
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
|
||||||
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
|
||||||
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#isnonsystem">isNonSystem</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
|
||||||
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
|
||||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
<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>
|
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||||
@ -1292,261 +1292,13 @@
|
|||||||
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
<h4 id="overrides_1">Overrides<a class="headerlink" href="#overrides_1" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#apibase">apiBase</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"StorageClass"</code></p>
|
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
|
||||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>false</code></p>
|
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
|
||||||
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
|
||||||
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
|
||||||
<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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.delete instead</p>
|
|
||||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#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>params?</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><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
|
||||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>humanize?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>compact?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>fromNow?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code> | <code>number</code></p>
|
|
||||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getAnnotations</strong>(<code>filter?</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>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="left"><code>filter?</code></td>
|
|
||||||
<td align="left"><code>boolean</code></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code>[]</p>
|
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
|
||||||
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
|
||||||
creation timestamp of this object.</p>
|
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
|
||||||
<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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
|
||||||
<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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
|
||||||
<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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>undefined</code></p>
|
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getreclaimpolicy">getReclaimPolicy<a class="headerlink" href="#getreclaimpolicy" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getReclaimPolicy</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="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getResourceVersion</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>
|
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
|
||||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
|
||||||
<p>(<code>undefined</code> | <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></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_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>number</code></p>
|
|
||||||
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="getvolumebindingmode">getVolumeBindingMode<a class="headerlink" href="#getvolumebindingmode" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>getVolumeBindingMode</strong>(): <code>string</code></p>
|
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>string</code></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="isdefault">isDefault<a class="headerlink" href="#isdefault" title="Permanent link">#</a></h3>
|
|
||||||
<p>▸ <strong>isDefault</strong>(): <code>boolean</code></p>
|
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" 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>
|
|
||||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.patch instead</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>patch</code></td>
|
|
||||||
<td align="left"><code>Patch</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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
|
||||||
<p><code>JsonObject</code></p>
|
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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
|
|
||||||
common race condition.</p>
|
|
||||||
<p><strong><code>Deprecated</code></strong></p>
|
|
||||||
<p>use KubeApi.update instead</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>data</code></td>
|
|
||||||
<td align="left"><code>Partial</code><<a href="./"><code>StorageClass</code></a>></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="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
|
||||||
<hr />
|
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<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="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p>▪ <code>Static</code> <strong>create</strong>: <Metadata, Status, Spec>(<code>data</code>: <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>) => <a href="../Main.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>
|
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>data</code>): <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1569,7 +1321,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1584,14 +1336,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h5 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h5>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></p>
|
<p><a href="../Main.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>
|
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#create">create</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_1">Type declaration<a class="headerlink" href="#type-declaration_1" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1606,14 +1362,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
<h5 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidata">isJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isJsonApiDataList</strong>: <T\>(<code>object</code>: <code>unknown</code>, <code>verifyItem</code>: (<code>val</code>: <code>unknown</code>) => val is T) => object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_2">Type declaration<a class="headerlink" href="#type-declaration_2" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ <<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1626,7 +1386,7 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1645,14 +1405,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h5 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiDataList<T></p>
|
<p>object is KubeJsonApiDataList<T></p>
|
||||||
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isjsonapidatalist">isJsonApiDataList</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>(<code>object</code>): object is KubeJsonApiListMetadata</p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_3">Type declaration<a class="headerlink" href="#type-declaration_3" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiListMetadata</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1667,14 +1431,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
<h5 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiListMetadata</p>
|
<p>object is KubeJsonApiListMetadata</p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
<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 KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_4">Type declaration<a class="headerlink" href="#type-declaration_4" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1689,14 +1457,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h5 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h5>
|
||||||
<p>object is KubeJsonApiObjectMetadata<KubeObjectScope></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>
|
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#iskubejsonapimetadata">isKubeJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>isNonSystem</strong>: (<code>item</code>: <a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>) => <code>boolean</code></p>
|
||||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_5">Type declaration<a class="headerlink" href="#type-declaration_5" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>item</code>): <code>boolean</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1711,14 +1483,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h5 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h5>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" 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><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#isnonsystem">isNonSystem</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_6">Type declaration<a class="headerlink" href="#type-declaration_6" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1733,14 +1509,18 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h5 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, 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>
|
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapidata">isPartialJsonApiData</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
<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<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_7">Type declaration<a class="headerlink" href="#type-declaration_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1755,14 +1535,28 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h5 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h5>
|
||||||
<p>object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></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>
|
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="kind_1">kind<a class="headerlink" href="#kind_1" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>kind</strong>: <code>"StorageClass"</code></p>
|
||||||
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#kind-1">kind</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="namespaced">namespaced<a class="headerlink" href="#namespaced" title="Permanent link">#</a></h3>
|
||||||
|
<p>▪ <code>Static</code> <code>Readonly</code> <strong>namespaced</strong>: <code>false</code></p>
|
||||||
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#namespaced">namespaced</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
<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>
|
<p>▪ <code>Static</code> <strong>stringifyLabels</strong>: (<code>labels?</code>: <code>Partial</code><<code>Record</code><<code>string</code>, <code>string</code>>>) => <code>string</code>[]</p>
|
||||||
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
|
<h4 id="type-declaration_8">Type declaration<a class="headerlink" href="#type-declaration_8" title="Permanent link">#</a></h4>
|
||||||
|
<p>▸ (<code>labels?</code>): <code>string</code>[]</p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>Switch to using <a href="../Main.K8sApi.KubeObject/#__type">__type</a> instead</p>
|
||||||
|
<h5 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h5>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
@ -1777,10 +1571,247 @@ common race condition.</p>
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h5 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h5>
|
||||||
<p><code>string</code>[]</p>
|
<p><code>string</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_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#stringifylabels">stringifyLabels</a></p>
|
||||||
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>get</code> <strong>selfLink</strong>(): <code>string</code></p>
|
||||||
|
<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_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||||
|
<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>void</code></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.delete instead</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>params?</code></td>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" 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>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#delete">delete</a></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>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||||
|
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering</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>humanize?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>compact?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>fromNow?</code></td>
|
||||||
|
<td align="left"><code>boolean</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> | <code>number</code></p>
|
||||||
|
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getage">getAge</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getannotations">getAnnotations<a class="headerlink" href="#getannotations" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getAnnotations</strong>(<code>filter?</code>): <code>string</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>filter?</code></td>
|
||||||
|
<td align="left"><code>boolean</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code>[]</p>
|
||||||
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getannotations">getAnnotations</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getcreationtimestamp">getCreationTimestamp<a class="headerlink" href="#getcreationtimestamp" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getCreationTimestamp</strong>(): <code>number</code></p>
|
||||||
|
<p>This function computes the number of milliseconds from the UNIX EPOCH to the
|
||||||
|
creation timestamp of this object.</p>
|
||||||
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getfinalizers">getFinalizers<a class="headerlink" href="#getfinalizers" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getFinalizers</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getfinalizers">getFinalizers</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getId</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getid">getId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getlabels">getLabels<a class="headerlink" href="#getlabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getLabels</strong>(): <code>string</code>[]</p>
|
||||||
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" 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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getlabels">getLabels</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getname">getName<a class="headerlink" href="#getname" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getName</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
|
<p><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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getname">getName</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getns">getNs<a class="headerlink" href="#getns" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getNs</strong>(): <code>undefined</code></p>
|
||||||
|
<h4 id="returns_18">Returns<a class="headerlink" href="#returns_18" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>undefined</code></p>
|
||||||
|
<h4 id="inherited-from_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getns">getNs</a></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>undefined</code> ; <code>uid</code>: <code>string</code> }[]</p>
|
||||||
|
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" 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>undefined</code> ; <code>uid</code>: <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="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getownerrefs">getOwnerRefs</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getreclaimpolicy">getReclaimPolicy<a class="headerlink" href="#getreclaimpolicy" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getReclaimPolicy</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
|
<p><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_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_25">Inherited from<a class="headerlink" href="#inherited-from_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></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_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
|
<p>(<code>undefined</code> | <code>string</code>)[]</p>
|
||||||
|
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></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></p>
|
||||||
|
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
|
||||||
|
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>number</code></p>
|
||||||
|
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="getvolumebindingmode">getVolumeBindingMode<a class="headerlink" href="#getvolumebindingmode" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>getVolumeBindingMode</strong>(): <code>string</code></p>
|
||||||
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>string</code></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="isdefault">isDefault<a class="headerlink" href="#isdefault" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isDefault</strong>(): <code>boolean</code></p>
|
||||||
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" 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>
|
||||||
|
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>patch</code></td>
|
||||||
|
<td align="left"><code>Patch</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.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>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Record</code><<code>string</code>, <code>unknown</code>></p>
|
||||||
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></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> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<p><strong><code>Deprecated</code></strong></p>
|
||||||
|
<p>use KubeApi.patch instead</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>data</code></td>
|
||||||
|
<td align="left"><code>Partial</code><<a href="./"><code>StorageClass</code></a>></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
|
<p><code>Promise</code><<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||||
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
|
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1410,48 +1410,48 @@
|
|||||||
<p>KubeObjectStore.items</p>
|
<p>KubeObjectStore.items</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="limit">limit<a class="headerlink" href="#limit" title="Permanent link">#</a></h3>
|
<h3 id="limit">limit<a class="headerlink" href="#limit" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>Readonly</code> <strong>limit</strong>: <code>undefined</code> | <code>number</code></p>
|
<p>• <code>Readonly</code> <strong>limit</strong>: <code>number</code></p>
|
||||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.limit</p>
|
<p>KubeObjectStore.limit</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="selecteditemsids">selectedItemsIds<a class="headerlink" href="#selecteditemsids" title="Permanent link">#</a></h3>
|
<h3 id="selecteditemsids">selectedItemsIds<a class="headerlink" href="#selecteditemsids" title="Permanent link">#</a></h3>
|
||||||
<p>• <strong>selectedItemsIds</strong>: <code>ObservableSet</code><<code>string</code>></p>
|
<p>• <strong>selectedItemsIds</strong>: <code>ObservableSet</code><<code>string</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_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.selectedItemsIds</p>
|
<p>KubeObjectStore.selectedItemsIds</p>
|
||||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="contextitems">contextItems<a class="headerlink" href="#contextitems" title="Permanent link">#</a></h3>
|
<h3 id="contextitems">contextItems<a class="headerlink" href="#contextitems" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>get</code> <strong>contextItems</strong>(): <code>K</code>[]</p>
|
<p>• <code>get</code> <strong>contextItems</strong>(): <code>K</code>[]</p>
|
||||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||||
<p><code>K</code>[]</p>
|
<p><code>K</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_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.contextItems</p>
|
<p>KubeObjectStore.contextItems</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="query">query<a class="headerlink" href="#query" title="Permanent link">#</a></h3>
|
<h3 id="query">query<a class="headerlink" href="#query" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>get</code> <strong>query</strong>(): <code>KubeApiQueryParams</code></p>
|
<p>• <code>get</code> <strong>query</strong>(): <code>KubeApiQueryParams</code></p>
|
||||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||||
<p><code>KubeApiQueryParams</code></p>
|
<p><code>KubeApiQueryParams</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_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.query</p>
|
<p>KubeObjectStore.query</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="selecteditems">selectedItems<a class="headerlink" href="#selecteditems" title="Permanent link">#</a></h3>
|
<h3 id="selecteditems">selectedItems<a class="headerlink" href="#selecteditems" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>get</code> <strong>selectedItems</strong>(): <code>Item</code>[]</p>
|
<p>• <code>get</code> <strong>selectedItems</strong>(): <code>Item</code>[]</p>
|
||||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||||
<p><code>Item</code>[]</p>
|
<p><code>Item</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_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.selectedItems</p>
|
<p>KubeObjectStore.selectedItems</p>
|
||||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="iterator">[iterator]<a class="headerlink" href="#iterator" title="Permanent link">#</a></h3>
|
<h3 id="iterator">[iterator]<a class="headerlink" href="#iterator" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>[iterator]</strong>(): <code>Generator</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>, <code>void</code>, <code>undefined</code>></p>
|
<p>▸ <strong>[iterator]</strong>(): <code>Generator</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>, <code>void</code>, <code>undefined</code>></p>
|
||||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||||
<p><code>Generator</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>, <code>void</code>, <code>undefined</code>></p>
|
<p><code>Generator</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>, <code>void</code>, <code>undefined</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_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.[iterator]</p>
|
<p>KubeObjectStore.[iterator]</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="bindwatcheventsupdater">bindWatchEventsUpdater<a class="headerlink" href="#bindwatcheventsupdater" title="Permanent link">#</a></h3>
|
<h3 id="bindwatcheventsupdater">bindWatchEventsUpdater<a class="headerlink" href="#bindwatcheventsupdater" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Protected</code> <strong>bindWatchEventsUpdater</strong>(): <code>void</code></p>
|
<p>▸ <code>Protected</code> <strong>bindWatchEventsUpdater</strong>(): <code>void</code></p>
|
||||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="overrides_2">Overrides<a class="headerlink" href="#overrides_2" title="Permanent link">#</a></h4>
|
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.bindWatchEventsUpdater</p>
|
<p>KubeObjectStore.bindWatchEventsUpdater</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
<h3 id="create">create<a class="headerlink" href="#create" title="Permanent link">#</a></h3>
|
||||||
@ -1485,7 +1485,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" 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><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
||||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" 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>KubeObjectStore.create</p>
|
<p>KubeObjectStore.create</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="createitem">createItem<a class="headerlink" href="#createitem" title="Permanent link">#</a></h3>
|
<h3 id="createitem">createItem<a class="headerlink" href="#createitem" title="Permanent link">#</a></h3>
|
||||||
@ -1519,7 +1519,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" 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>null</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
<p><code>Promise</code><<code>null</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
||||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" 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>KubeObjectStore.createItem</p>
|
<p>KubeObjectStore.createItem</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="filteritemsonload">filterItemsOnLoad<a class="headerlink" href="#filteritemsonload" title="Permanent link">#</a></h3>
|
<h3 id="filteritemsonload">filterItemsOnLoad<a class="headerlink" href="#filteritemsonload" title="Permanent link">#</a></h3>
|
||||||
@ -1541,7 +1541,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
||||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" 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>KubeObjectStore.filterItemsOnLoad</p>
|
<p>KubeObjectStore.filterItemsOnLoad</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getallbyns">getAllByNs<a class="headerlink" href="#getallbyns" title="Permanent link">#</a></h3>
|
<h3 id="getallbyns">getAllByNs<a class="headerlink" href="#getallbyns" title="Permanent link">#</a></h3>
|
||||||
@ -1567,7 +1567,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
||||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" 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>KubeObjectStore.getAllByNs</p>
|
<p>KubeObjectStore.getAllByNs</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getbyid">getById<a class="headerlink" href="#getbyid" title="Permanent link">#</a></h3>
|
<h3 id="getbyid">getById<a class="headerlink" href="#getbyid" title="Permanent link">#</a></h3>
|
||||||
@ -1589,7 +1589,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||||
<p><code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a></p>
|
<p><code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a></p>
|
||||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.getById</p>
|
<p>KubeObjectStore.getById</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getbylabel">getByLabel<a class="headerlink" href="#getbylabel" title="Permanent link">#</a></h3>
|
<h3 id="getbylabel">getByLabel<a class="headerlink" href="#getbylabel" title="Permanent link">#</a></h3>
|
||||||
@ -1611,7 +1611,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</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_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.getByLabel</p>
|
<p>KubeObjectStore.getByLabel</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getbyname">getByName<a class="headerlink" href="#getbyname" title="Permanent link">#</a></h3>
|
<h3 id="getbyname">getByName<a class="headerlink" href="#getbyname" title="Permanent link">#</a></h3>
|
||||||
@ -1637,7 +1637,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||||
<p><code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a></p>
|
<p><code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a></p>
|
||||||
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.getByName</p>
|
<p>KubeObjectStore.getByName</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getbypath">getByPath<a class="headerlink" href="#getbypath" title="Permanent link">#</a></h3>
|
<h3 id="getbypath">getByPath<a class="headerlink" href="#getbypath" title="Permanent link">#</a></h3>
|
||||||
@ -1659,7 +1659,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||||
<p><code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a></p>
|
<p><code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a></p>
|
||||||
<h4 id="inherited-from_21">Inherited from<a class="headerlink" href="#inherited-from_21" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_20">Inherited from<a class="headerlink" href="#inherited-from_20" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.getByPath</p>
|
<p>KubeObjectStore.getByPath</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="geteventsbyobject">getEventsByObject<a class="headerlink" href="#geteventsbyobject" title="Permanent link">#</a></h3>
|
<h3 id="geteventsbyobject">getEventsByObject<a class="headerlink" href="#geteventsbyobject" title="Permanent link">#</a></h3>
|
||||||
@ -1701,21 +1701,21 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||||
<p><code>number</code></p>
|
<p><code>number</code></p>
|
||||||
<h4 id="inherited-from_22">Inherited from<a class="headerlink" href="#inherited-from_22" 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>KubeObjectStore.getIndexById</p>
|
<p>KubeObjectStore.getIndexById</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getitems">getItems<a class="headerlink" href="#getitems" title="Permanent link">#</a></h3>
|
<h3 id="getitems">getItems<a class="headerlink" href="#getitems" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getItems</strong>(): <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
<p>▸ <strong>getItems</strong>(): <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
||||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</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_22">Inherited from<a class="headerlink" href="#inherited-from_22" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.getItems</p>
|
<p>KubeObjectStore.getItems</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="gettotalcount">getTotalCount<a class="headerlink" href="#gettotalcount" title="Permanent link">#</a></h3>
|
<h3 id="gettotalcount">getTotalCount<a class="headerlink" href="#gettotalcount" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>getTotalCount</strong>(): <code>number</code></p>
|
<p>▸ <strong>getTotalCount</strong>(): <code>number</code></p>
|
||||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||||
<p><code>number</code></p>
|
<p><code>number</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_23">Inherited from<a class="headerlink" href="#inherited-from_23" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.getTotalCount</p>
|
<p>KubeObjectStore.getTotalCount</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="getwarnings">getWarnings<a class="headerlink" href="#getwarnings" title="Permanent link">#</a></h3>
|
<h3 id="getwarnings">getWarnings<a class="headerlink" href="#getwarnings" title="Permanent link">#</a></h3>
|
||||||
@ -1747,7 +1747,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</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_24">Inherited from<a class="headerlink" href="#inherited-from_24" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.isSelected</p>
|
<p>KubeObjectStore.isSelected</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="isselectedall">isSelectedAll<a class="headerlink" href="#isselectedall" title="Permanent link">#</a></h3>
|
<h3 id="isselectedall">isSelectedAll<a class="headerlink" href="#isselectedall" title="Permanent link">#</a></h3>
|
||||||
@ -1769,7 +1769,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
<h4 id="returns_21">Returns<a class="headerlink" href="#returns_21" title="Permanent link">#</a></h4>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" 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>KubeObjectStore.isSelectedAll</p>
|
<p>KubeObjectStore.isSelectedAll</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="load">load<a class="headerlink" href="#load" title="Permanent link">#</a></h3>
|
<h3 id="load">load<a class="headerlink" href="#load" title="Permanent link">#</a></h3>
|
||||||
@ -1799,7 +1799,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" 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="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</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_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.load</p>
|
<p>KubeObjectStore.load</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="loadall">loadAll<a class="headerlink" href="#loadall" title="Permanent link">#</a></h3>
|
<h3 id="loadall">loadAll<a class="headerlink" href="#loadall" title="Permanent link">#</a></h3>
|
||||||
@ -1821,7 +1821,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]></p>
|
<p><code>Promise</code><<code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</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_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.loadAll</p>
|
<p>KubeObjectStore.loadAll</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="loadfrompath">loadFromPath<a class="headerlink" href="#loadfrompath" title="Permanent link">#</a></h3>
|
<h3 id="loadfrompath">loadFromPath<a class="headerlink" href="#loadfrompath" title="Permanent link">#</a></h3>
|
||||||
@ -1843,7 +1843,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" 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><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
||||||
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" 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>KubeObjectStore.loadFromPath</p>
|
<p>KubeObjectStore.loadFromPath</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="loaditem">loadItem<a class="headerlink" href="#loaditem" title="Permanent link">#</a></h3>
|
<h3 id="loaditem">loadItem<a class="headerlink" href="#loaditem" title="Permanent link">#</a></h3>
|
||||||
@ -1873,7 +1873,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<code>null</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
<p><code>Promise</code><<code>null</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</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_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.loadItem</p>
|
<p>KubeObjectStore.loadItem</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="loaditems">loadItems<a class="headerlink" href="#loaditems" title="Permanent link">#</a></h3>
|
<h3 id="loaditems">loadItems<a class="headerlink" href="#loaditems" title="Permanent link">#</a></h3>
|
||||||
@ -1895,7 +1895,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]></p>
|
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]></p>
|
||||||
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.loadItems</p>
|
<p>KubeObjectStore.loadItems</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="mergeitems">mergeItems<a class="headerlink" href="#mergeitems" title="Permanent link">#</a></h3>
|
<h3 id="mergeitems">mergeItems<a class="headerlink" href="#mergeitems" title="Permanent link">#</a></h3>
|
||||||
@ -1921,7 +1921,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
||||||
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.mergeItems</p>
|
<p>KubeObjectStore.mergeItems</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||||
@ -1947,7 +1947,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
||||||
<h4 id="inherited-from_33">Inherited from<a class="headerlink" href="#inherited-from_33" 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>KubeObjectStore.patch</p>
|
<p>KubeObjectStore.patch</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="pickonlyselected">pickOnlySelected<a class="headerlink" href="#pickonlyselected" title="Permanent link">#</a></h3>
|
<h3 id="pickonlyselected">pickOnlySelected<a class="headerlink" href="#pickonlyselected" title="Permanent link">#</a></h3>
|
||||||
@ -1969,7 +1969,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
||||||
<h4 id="inherited-from_34">Inherited from<a class="headerlink" href="#inherited-from_34" 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>KubeObjectStore.pickOnlySelected</p>
|
<p>KubeObjectStore.pickOnlySelected</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="reloadall">reloadAll<a class="headerlink" href="#reloadall" title="Permanent link">#</a></h3>
|
<h3 id="reloadall">reloadAll<a class="headerlink" href="#reloadall" title="Permanent link">#</a></h3>
|
||||||
@ -2003,7 +2003,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]></p>
|
<p><code>Promise</code><<code>undefined</code> | <a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]></p>
|
||||||
<h4 id="inherited-from_35">Inherited from<a class="headerlink" href="#inherited-from_35" 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>KubeObjectStore.reloadAll</p>
|
<p>KubeObjectStore.reloadAll</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="remove">remove<a class="headerlink" href="#remove" title="Permanent link">#</a></h3>
|
<h3 id="remove">remove<a class="headerlink" href="#remove" title="Permanent link">#</a></h3>
|
||||||
@ -2025,7 +2025,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<code>void</code>></p>
|
<p><code>Promise</code><<code>void</code>></p>
|
||||||
<h4 id="inherited-from_36">Inherited from<a class="headerlink" href="#inherited-from_36" 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>KubeObjectStore.remove</p>
|
<p>KubeObjectStore.remove</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="removeitem">removeItem<a class="headerlink" href="#removeitem" title="Permanent link">#</a></h3>
|
<h3 id="removeitem">removeItem<a class="headerlink" href="#removeitem" title="Permanent link">#</a></h3>
|
||||||
@ -2051,7 +2051,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<code>void</code>></p>
|
<p><code>Promise</code><<code>void</code>></p>
|
||||||
<h4 id="inherited-from_37">Inherited from<a class="headerlink" href="#inherited-from_37" 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>KubeObjectStore.removeItem</p>
|
<p>KubeObjectStore.removeItem</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="removeitems">removeItems<a class="headerlink" href="#removeitems" title="Permanent link">#</a></h3>
|
<h3 id="removeitems">removeItems<a class="headerlink" href="#removeitems" title="Permanent link">#</a></h3>
|
||||||
@ -2073,21 +2073,21 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<code>void</code>></p>
|
<p><code>Promise</code><<code>void</code>></p>
|
||||||
<h4 id="inherited-from_38">Inherited from<a class="headerlink" href="#inherited-from_38" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_37">Inherited from<a class="headerlink" href="#inherited-from_37" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.removeItems</p>
|
<p>KubeObjectStore.removeItems</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="removeselecteditems">removeSelectedItems<a class="headerlink" href="#removeselecteditems" title="Permanent link">#</a></h3>
|
<h3 id="removeselecteditems">removeSelectedItems<a class="headerlink" href="#removeselecteditems" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>removeSelectedItems</strong>(): <code>Promise</code><<code>void</code>></p>
|
<p>▸ <strong>removeSelectedItems</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||||
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<code>void</code>></p>
|
<p><code>Promise</code><<code>void</code>></p>
|
||||||
<h4 id="inherited-from_39">Inherited from<a class="headerlink" href="#inherited-from_39" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_38">Inherited from<a class="headerlink" href="#inherited-from_38" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.removeSelectedItems</p>
|
<p>KubeObjectStore.removeSelectedItems</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="reset">reset<a class="headerlink" href="#reset" title="Permanent link">#</a></h3>
|
<h3 id="reset">reset<a class="headerlink" href="#reset" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>reset</strong>(): <code>void</code></p>
|
<p>▸ <strong>reset</strong>(): <code>void</code></p>
|
||||||
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="inherited-from_40">Inherited from<a class="headerlink" href="#inherited-from_40" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_39">Inherited from<a class="headerlink" href="#inherited-from_39" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.reset</p>
|
<p>KubeObjectStore.reset</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="resetonerror">resetOnError<a class="headerlink" href="#resetonerror" title="Permanent link">#</a></h3>
|
<h3 id="resetonerror">resetOnError<a class="headerlink" href="#resetonerror" title="Permanent link">#</a></h3>
|
||||||
@ -2109,14 +2109,14 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="inherited-from_41">Inherited from<a class="headerlink" href="#inherited-from_41" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_40">Inherited from<a class="headerlink" href="#inherited-from_40" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.resetOnError</p>
|
<p>KubeObjectStore.resetOnError</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="resetselection">resetSelection<a class="headerlink" href="#resetselection" title="Permanent link">#</a></h3>
|
<h3 id="resetselection">resetSelection<a class="headerlink" href="#resetselection" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <strong>resetSelection</strong>(): <code>void</code></p>
|
<p>▸ <strong>resetSelection</strong>(): <code>void</code></p>
|
||||||
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="inherited-from_42">Inherited from<a class="headerlink" href="#inherited-from_42" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_41">Inherited from<a class="headerlink" href="#inherited-from_41" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.resetSelection</p>
|
<p>KubeObjectStore.resetSelection</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="select">select<a class="headerlink" href="#select" title="Permanent link">#</a></h3>
|
<h3 id="select">select<a class="headerlink" href="#select" title="Permanent link">#</a></h3>
|
||||||
@ -2138,7 +2138,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
|
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="inherited-from_43">Inherited from<a class="headerlink" href="#inherited-from_43" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_42">Inherited from<a class="headerlink" href="#inherited-from_42" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.select</p>
|
<p>KubeObjectStore.select</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="sortitems">sortItems<a class="headerlink" href="#sortitems" title="Permanent link">#</a></h3>
|
<h3 id="sortitems">sortItems<a class="headerlink" href="#sortitems" title="Permanent link">#</a></h3>
|
||||||
@ -2160,7 +2160,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_39">Returns<a class="headerlink" href="#returns_39" title="Permanent link">#</a></h4>
|
<h4 id="returns_39">Returns<a class="headerlink" href="#returns_39" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
<p><a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>[]</p>
|
||||||
<h4 id="overrides_3">Overrides<a class="headerlink" href="#overrides_3" title="Permanent link">#</a></h4>
|
<h4 id="overrides_4">Overrides<a class="headerlink" href="#overrides_4" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.sortItems</p>
|
<p>KubeObjectStore.sortItems</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="subscribe">subscribe<a class="headerlink" href="#subscribe" title="Permanent link">#</a></h3>
|
<h3 id="subscribe">subscribe<a class="headerlink" href="#subscribe" title="Permanent link">#</a></h3>
|
||||||
@ -2182,7 +2182,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_40">Returns<a class="headerlink" href="#returns_40" title="Permanent link">#</a></h4>
|
<h4 id="returns_40">Returns<a class="headerlink" href="#returns_40" title="Permanent link">#</a></h4>
|
||||||
<p><a href="../../interfaces/Common.Util.Disposer/"><code>Disposer</code></a></p>
|
<p><a href="../../interfaces/Common.Util.Disposer/"><code>Disposer</code></a></p>
|
||||||
<h4 id="inherited-from_44">Inherited from<a class="headerlink" href="#inherited-from_44" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_43">Inherited from<a class="headerlink" href="#inherited-from_43" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.subscribe</p>
|
<p>KubeObjectStore.subscribe</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="toggleselection">toggleSelection<a class="headerlink" href="#toggleselection" title="Permanent link">#</a></h3>
|
<h3 id="toggleselection">toggleSelection<a class="headerlink" href="#toggleselection" title="Permanent link">#</a></h3>
|
||||||
@ -2204,7 +2204,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_41">Returns<a class="headerlink" href="#returns_41" title="Permanent link">#</a></h4>
|
<h4 id="returns_41">Returns<a class="headerlink" href="#returns_41" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="inherited-from_45">Inherited from<a class="headerlink" href="#inherited-from_45" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_44">Inherited from<a class="headerlink" href="#inherited-from_44" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.toggleSelection</p>
|
<p>KubeObjectStore.toggleSelection</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="toggleselectionall">toggleSelectionAll<a class="headerlink" href="#toggleselectionall" title="Permanent link">#</a></h3>
|
<h3 id="toggleselectionall">toggleSelectionAll<a class="headerlink" href="#toggleselectionall" title="Permanent link">#</a></h3>
|
||||||
@ -2226,7 +2226,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_42">Returns<a class="headerlink" href="#returns_42" title="Permanent link">#</a></h4>
|
<h4 id="returns_42">Returns<a class="headerlink" href="#returns_42" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="inherited-from_46">Inherited from<a class="headerlink" href="#inherited-from_46" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_45">Inherited from<a class="headerlink" href="#inherited-from_45" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.toggleSelectionAll</p>
|
<p>KubeObjectStore.toggleSelectionAll</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="unselect">unselect<a class="headerlink" href="#unselect" title="Permanent link">#</a></h3>
|
<h3 id="unselect">unselect<a class="headerlink" href="#unselect" title="Permanent link">#</a></h3>
|
||||||
@ -2248,7 +2248,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_43">Returns<a class="headerlink" href="#returns_43" title="Permanent link">#</a></h4>
|
<h4 id="returns_43">Returns<a class="headerlink" href="#returns_43" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="inherited-from_47">Inherited from<a class="headerlink" href="#inherited-from_47" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_46">Inherited from<a class="headerlink" href="#inherited-from_46" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.unselect</p>
|
<p>KubeObjectStore.unselect</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
<h3 id="update">update<a class="headerlink" href="#update" title="Permanent link">#</a></h3>
|
||||||
@ -2274,14 +2274,14 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_44">Returns<a class="headerlink" href="#returns_44" title="Permanent link">#</a></h4>
|
<h4 id="returns_44">Returns<a class="headerlink" href="#returns_44" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
||||||
<h4 id="inherited-from_48">Inherited from<a class="headerlink" href="#inherited-from_48" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_47">Inherited from<a class="headerlink" href="#inherited-from_47" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.update</p>
|
<p>KubeObjectStore.update</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="updatefromeventsbuffer">updateFromEventsBuffer<a class="headerlink" href="#updatefromeventsbuffer" title="Permanent link">#</a></h3>
|
<h3 id="updatefromeventsbuffer">updateFromEventsBuffer<a class="headerlink" href="#updatefromeventsbuffer" title="Permanent link">#</a></h3>
|
||||||
<p>▸ <code>Protected</code> <strong>updateFromEventsBuffer</strong>(): <code>void</code></p>
|
<p>▸ <code>Protected</code> <strong>updateFromEventsBuffer</strong>(): <code>void</code></p>
|
||||||
<h4 id="returns_45">Returns<a class="headerlink" href="#returns_45" title="Permanent link">#</a></h4>
|
<h4 id="returns_45">Returns<a class="headerlink" href="#returns_45" title="Permanent link">#</a></h4>
|
||||||
<p><code>void</code></p>
|
<p><code>void</code></p>
|
||||||
<h4 id="inherited-from_49">Inherited from<a class="headerlink" href="#inherited-from_49" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_48">Inherited from<a class="headerlink" href="#inherited-from_48" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.updateFromEventsBuffer</p>
|
<p>KubeObjectStore.updateFromEventsBuffer</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="updateitem">updateItem<a class="headerlink" href="#updateitem" title="Permanent link">#</a></h3>
|
<h3 id="updateitem">updateItem<a class="headerlink" href="#updateitem" title="Permanent link">#</a></h3>
|
||||||
@ -2307,7 +2307,7 @@
|
|||||||
</table>
|
</table>
|
||||||
<h4 id="returns_46">Returns<a class="headerlink" href="#returns_46" title="Permanent link">#</a></h4>
|
<h4 id="returns_46">Returns<a class="headerlink" href="#returns_46" title="Permanent link">#</a></h4>
|
||||||
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
<p><code>Promise</code><<a href="../Main.K8sApi.KubeEvent/"><code>KubeEvent</code></a>></p>
|
||||||
<h4 id="inherited-from_50">Inherited from<a class="headerlink" href="#inherited-from_50" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_49">Inherited from<a class="headerlink" href="#inherited-from_49" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.updateItem</p>
|
<p>KubeObjectStore.updateItem</p>
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1361,7 +1361,7 @@
|
|||||||
<p>KubeObjectStore.dependencies</p>
|
<p>KubeObjectStore.dependencies</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="eventsbuffer">eventsBuffer<a class="headerlink" href="#eventsbuffer" title="Permanent link">#</a></h3>
|
<h3 id="eventsbuffer">eventsBuffer<a class="headerlink" href="#eventsbuffer" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>eventsBuffer</strong>: <code>IObservableArray</code><<code>IKubeWatchEvent</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<code>IngressClassMetadata</code>, <code>IngressClassStatus</code>, <code>IngressClassSpec</code>>>></p>
|
<p>• <code>Protected</code> <code>Readonly</code> <strong>eventsBuffer</strong>: <code>IObservableArray</code><<code>IKubeWatchEvent</code><<a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Main.K8sApi/#clusterscopedmetadata"><code>ClusterScopedMetadata</code></a>, <code>IngressClassStatus</code>, <code>IngressClassSpec</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_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||||
<p>KubeObjectStore.eventsBuffer</p>
|
<p>KubeObjectStore.eventsBuffer</p>
|
||||||
<hr />
|
<hr />
|
||||||
|
|||||||
@ -942,7 +942,7 @@ preserved when modifying objects.</p>
|
|||||||
<p>• <code>Optional</code> <strong>clusterName</strong>: <code>string</code></p>
|
<p>• <code>Optional</code> <strong>clusterName</strong>: <code>string</code></p>
|
||||||
<p>The name of the cluster which the object belongs to. This is used to distinguish resources
|
<p>The name of the cluster which the object belongs to. This is used to distinguish resources
|
||||||
with same name and namespace in different clusters. This field is not set anywhere right now
|
with same name and namespace in different clusters. This field is not set anywhere right now
|
||||||
and apiserver is going to ignore it if set in create or update request.</p>
|
and api server is going to ignore it if set in create or update request.</p>
|
||||||
<hr />
|
<hr />
|
||||||
<h3 id="creationtimestamp">creationTimestamp<a class="headerlink" href="#creationtimestamp" title="Permanent link">#</a></h3>
|
<h3 id="creationtimestamp">creationTimestamp<a class="headerlink" href="#creationtimestamp" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>Optional</code> <code>Readonly</code> <strong>creationTimestamp</strong>: <code>string</code></p>
|
<p>• <code>Optional</code> <code>Readonly</code> <strong>creationTimestamp</strong>: <code>string</code></p>
|
||||||
|
|||||||
@ -721,13 +721,6 @@
|
|||||||
Type parameters
|
Type parameters
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="#hierarchy" class="md-nav__link">
|
|
||||||
Hierarchy
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -846,11 +839,6 @@
|
|||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
|
||||||
<ul>
|
|
||||||
<li><code>JsonApiData</code></li>
|
|
||||||
</ul>
|
|
||||||
<p>↳ <strong><code>KubeJsonApiData</code></strong></p>
|
|
||||||
<h2 id="indexable">Indexable<a class="headerlink" href="#indexable" title="Permanent link">#</a></h2>
|
<h2 id="indexable">Indexable<a class="headerlink" href="#indexable" title="Permanent link">#</a></h2>
|
||||||
<p>▪ [otherKeys: <code>string</code>]: <code>unknown</code></p>
|
<p>▪ [otherKeys: <code>string</code>]: <code>unknown</code></p>
|
||||||
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||||
|
|||||||
@ -770,6 +770,13 @@
|
|||||||
className
|
className
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#columns" class="md-nav__link">
|
||||||
|
columns
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -1066,6 +1073,7 @@
|
|||||||
<ul>
|
<ul>
|
||||||
<li><a href="./#addremovebuttons">addRemoveButtons</a></li>
|
<li><a href="./#addremovebuttons">addRemoveButtons</a></li>
|
||||||
<li><a href="./#classname">className</a></li>
|
<li><a href="./#classname">className</a></li>
|
||||||
|
<li><a href="./#columns">columns</a></li>
|
||||||
<li><a href="./#copyclassnamefromheadcells">copyClassNameFromHeadCells</a></li>
|
<li><a href="./#copyclassnamefromheadcells">copyClassNameFromHeadCells</a></li>
|
||||||
<li><a href="./#customizeheader">customizeHeader</a></li>
|
<li><a href="./#customizeheader">customizeHeader</a></li>
|
||||||
<li><a href="./#customizeremovedialog">customizeRemoveDialog</a></li>
|
<li><a href="./#customizeremovedialog">customizeRemoveDialog</a></li>
|
||||||
@ -1112,6 +1120,9 @@
|
|||||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||||
<p>Omit.className</p>
|
<p>Omit.className</p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="columns">columns<a class="headerlink" href="#columns" title="Permanent link">#</a></h3>
|
||||||
|
<p>• <code>Optional</code> <strong>columns</strong>: <code>SpecificKubeListLayoutColumn</code><<code>K</code>>[]</p>
|
||||||
|
<hr />
|
||||||
<h3 id="copyclassnamefromheadcells">copyClassNameFromHeadCells<a class="headerlink" href="#copyclassnamefromheadcells" title="Permanent link">#</a></h3>
|
<h3 id="copyclassnamefromheadcells">copyClassNameFromHeadCells<a class="headerlink" href="#copyclassnamefromheadcells" title="Permanent link">#</a></h3>
|
||||||
<p>• <code>Optional</code> <strong>copyClassNameFromHeadCells</strong>: <code>boolean</code></p>
|
<p>• <code>Optional</code> <strong>copyClassNameFromHeadCells</strong>: <code>boolean</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_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||||
|
|||||||
@ -724,6 +724,13 @@
|
|||||||
<nav class="md-nav" aria-label="Table of contents">
|
<nav class="md-nav" aria-label="Table of contents">
|
||||||
<ul class="md-nav__list">
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#references" class="md-nav__link">
|
||||||
|
References
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#classes" class="md-nav__link">
|
<a href="#classes" class="md-nav__link">
|
||||||
Classes
|
Classes
|
||||||
@ -762,6 +769,82 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#references_1" class="md-nav__link">
|
||||||
|
References
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<nav class="md-nav" aria-label="References">
|
||||||
|
<ul class="md-nav__list">
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#createkubeobject" class="md-nav__link">
|
||||||
|
createKubeObject
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubeobjectnonsystem" class="md-nav__link">
|
||||||
|
isKubeObjectNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -978,6 +1061,13 @@
|
|||||||
isAllowedResource
|
isAllowedResource
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubestatusdata" class="md-nav__link">
|
||||||
|
isKubeStatusData
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1004,6 +1094,18 @@
|
|||||||
<h1 id="namespace-k8sapi">Namespace: K8sApi<a class="headerlink" href="#namespace-k8sapi" title="Permanent link">#</a></h1>
|
<h1 id="namespace-k8sapi">Namespace: K8sApi<a class="headerlink" href="#namespace-k8sapi" title="Permanent link">#</a></h1>
|
||||||
<p><a href="../Main/">Main</a>.K8sApi</p>
|
<p><a href="../Main/">Main</a>.K8sApi</p>
|
||||||
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="references">References<a class="headerlink" href="#references" title="Permanent link">#</a></h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="./#createkubeobject">createKubeObject</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#iskubeobjectnonsystem">isKubeObjectNonSystem</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
|
</ul>
|
||||||
<h3 id="classes">Classes<a class="headerlink" href="#classes" title="Permanent link">#</a></h3>
|
<h3 id="classes">Classes<a class="headerlink" href="#classes" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="../../classes/Main.K8sApi.ClusterRole/">ClusterRole</a></li>
|
<li><a href="../../classes/Main.K8sApi.ClusterRole/">ClusterRole</a></li>
|
||||||
@ -1093,7 +1195,35 @@
|
|||||||
<li><a href="./#forremotecluster">forRemoteCluster</a></li>
|
<li><a href="./#forremotecluster">forRemoteCluster</a></li>
|
||||||
<li><a href="./#getpodsbyownerid">getPodsByOwnerId</a></li>
|
<li><a href="./#getpodsbyownerid">getPodsByOwnerId</a></li>
|
||||||
<li><a href="./#isallowedresource">isAllowedResource</a></li>
|
<li><a href="./#isallowedresource">isAllowedResource</a></li>
|
||||||
|
<li><a href="./#iskubestatusdata">isKubeStatusData</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<h2 id="references_1">References<a class="headerlink" href="#references_1" title="Permanent link">#</a></h2>
|
||||||
|
<h3 id="createkubeobject">createKubeObject<a class="headerlink" href="#createkubeobject" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iskubeobjectnonsystem">isKubeObjectNonSystem<a class="headerlink" href="#iskubeobjectnonsystem" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
<h2 id="type-aliases_1">Type Aliases<a class="headerlink" href="#type-aliases_1" title="Permanent link">#</a></h2>
|
<h2 id="type-aliases_1">Type Aliases<a class="headerlink" href="#type-aliases_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="clusterscopedmetadata">ClusterScopedMetadata<a class="headerlink" href="#clusterscopedmetadata" title="Permanent link">#</a></h3>
|
<h3 id="clusterscopedmetadata">ClusterScopedMetadata<a class="headerlink" href="#clusterscopedmetadata" title="Permanent link">#</a></h3>
|
||||||
<p>Ƭ <strong>ClusterScopedMetadata</strong>: <a href="./#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope.Cluster</code>></p>
|
<p>Ƭ <strong>ClusterScopedMetadata</strong>: <a href="./#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope.Cluster</code>></p>
|
||||||
@ -1599,6 +1729,29 @@
|
|||||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||||
<p><code>boolean</code></p>
|
<p><code>boolean</code></p>
|
||||||
<p>false</p>
|
<p>false</p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iskubestatusdata">isKubeStatusData<a class="headerlink" href="#iskubestatusdata" title="Permanent link">#</a></h3>
|
||||||
|
<p>▸ <strong>isKubeStatusData</strong>(<code>object</code>): object is KubeStatusData</p>
|
||||||
|
<p>Is the shape of object correct for <a href="../../interfaces/Main.K8sApi.KubeStatusData/">KubeStatusData</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">Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>object</code></td>
|
||||||
|
<td align="left"><code>unknown</code></td>
|
||||||
|
<td align="left">Some object</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||||
|
<p>object is KubeStatusData</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1232,6 +1232,13 @@
|
|||||||
apiManager
|
apiManager
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#createkubeobject" class="md-nav__link">
|
||||||
|
createKubeObject
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@ -1260,6 +1267,69 @@
|
|||||||
getPodsByOwnerId
|
getPodsByOwnerId
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidata" class="md-nav__link">
|
||||||
|
isJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#isjsonapidatalist" class="md-nav__link">
|
||||||
|
isJsonApiDataList
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapilistmetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiListMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubejsonapimetadata" class="md-nav__link">
|
||||||
|
isKubeJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubeobjectnonsystem" class="md-nav__link">
|
||||||
|
isKubeObjectNonSystem
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#iskubestatusdata" class="md-nav__link">
|
||||||
|
isKubeStatusData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapidata" class="md-nav__link">
|
||||||
|
isPartialJsonApiData
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#ispartialjsonapimetadata" class="md-nav__link">
|
||||||
|
isPartialJsonApiMetadata
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="md-nav__item">
|
||||||
|
<a href="#stringifylabels" class="md-nav__link">
|
||||||
|
stringifyLabels
|
||||||
|
</a>
|
||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
@ -1629,10 +1699,20 @@
|
|||||||
<li><a href="./#statefulset">StatefulSet</a></li>
|
<li><a href="./#statefulset">StatefulSet</a></li>
|
||||||
<li><a href="./#storageclass">StorageClass</a></li>
|
<li><a href="./#storageclass">StorageClass</a></li>
|
||||||
<li><a href="./#apimanager">apiManager</a></li>
|
<li><a href="./#apimanager">apiManager</a></li>
|
||||||
|
<li><a href="./#createkubeobject">createKubeObject</a></li>
|
||||||
<li><a href="./#createresourcestack">createResourceStack</a></li>
|
<li><a href="./#createresourcestack">createResourceStack</a></li>
|
||||||
<li><a href="./#forcluster">forCluster</a></li>
|
<li><a href="./#forcluster">forCluster</a></li>
|
||||||
<li><a href="./#forremotecluster">forRemoteCluster</a></li>
|
<li><a href="./#forremotecluster">forRemoteCluster</a></li>
|
||||||
<li><a href="./#getpodsbyownerid">getPodsByOwnerId</a></li>
|
<li><a href="./#getpodsbyownerid">getPodsByOwnerId</a></li>
|
||||||
|
<li><a href="./#isjsonapidata">isJsonApiData</a></li>
|
||||||
|
<li><a href="./#isjsonapidatalist">isJsonApiDataList</a></li>
|
||||||
|
<li><a href="./#iskubejsonapilistmetadata">isKubeJsonApiListMetadata</a></li>
|
||||||
|
<li><a href="./#iskubejsonapimetadata">isKubeJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#iskubeobjectnonsystem">isKubeObjectNonSystem</a></li>
|
||||||
|
<li><a href="./#iskubestatusdata">isKubeStatusData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapidata">isPartialJsonApiData</a></li>
|
||||||
|
<li><a href="./#ispartialjsonapimetadata">isPartialJsonApiMetadata</a></li>
|
||||||
|
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3 id="enumerations">Enumerations<a class="headerlink" href="#enumerations" title="Permanent link">#</a></h3>
|
<h3 id="enumerations">Enumerations<a class="headerlink" href="#enumerations" title="Permanent link">#</a></h3>
|
||||||
<ul>
|
<ul>
|
||||||
@ -1915,6 +1995,9 @@
|
|||||||
<h3 id="apimanager">apiManager<a class="headerlink" href="#apimanager" title="Permanent link">#</a></h3>
|
<h3 id="apimanager">apiManager<a class="headerlink" href="#apimanager" title="Permanent link">#</a></h3>
|
||||||
<p>Re-exports <a href="../Main.K8sApi/#apimanager">apiManager</a></p>
|
<p>Re-exports <a href="../Main.K8sApi/#apimanager">apiManager</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
|
<h3 id="createkubeobject">createKubeObject<a class="headerlink" href="#createkubeobject" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
<h3 id="createresourcestack">createResourceStack<a class="headerlink" href="#createresourcestack" title="Permanent link">#</a></h3>
|
<h3 id="createresourcestack">createResourceStack<a class="headerlink" href="#createresourcestack" title="Permanent link">#</a></h3>
|
||||||
<p>Re-exports <a href="../Main.K8sApi/#createresourcestack">createResourceStack</a></p>
|
<p>Re-exports <a href="../Main.K8sApi/#createresourcestack">createResourceStack</a></p>
|
||||||
<hr />
|
<hr />
|
||||||
@ -1926,6 +2009,33 @@
|
|||||||
<hr />
|
<hr />
|
||||||
<h3 id="getpodsbyownerid">getPodsByOwnerId<a class="headerlink" href="#getpodsbyownerid" title="Permanent link">#</a></h3>
|
<h3 id="getpodsbyownerid">getPodsByOwnerId<a class="headerlink" href="#getpodsbyownerid" title="Permanent link">#</a></h3>
|
||||||
<p>Re-exports <a href="../Main.K8sApi/#getpodsbyownerid">getPodsByOwnerId</a></p>
|
<p>Re-exports <a href="../Main.K8sApi/#getpodsbyownerid">getPodsByOwnerId</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iskubejsonapilistmetadata">isKubeJsonApiListMetadata<a class="headerlink" href="#iskubejsonapilistmetadata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iskubeobjectnonsystem">isKubeObjectNonSystem<a class="headerlink" href="#iskubeobjectnonsystem" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="iskubestatusdata">isKubeStatusData<a class="headerlink" href="#iskubestatusdata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Re-exports <a href="../Main.K8sApi/#iskubestatusdata">isKubeStatusData</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
|
<hr />
|
||||||
|
<h3 id="stringifylabels">stringifyLabels<a class="headerlink" href="#stringifylabels" title="Permanent link">#</a></h3>
|
||||||
|
<p>Renames and re-exports <a href="../../classes/Main.K8sApi.KubeObject/#__type">__type</a></p>
|
||||||
<h2 id="type-aliases_1">Type Aliases<a class="headerlink" href="#type-aliases_1" title="Permanent link">#</a></h2>
|
<h2 id="type-aliases_1">Type Aliases<a class="headerlink" href="#type-aliases_1" title="Permanent link">#</a></h2>
|
||||||
<h3 id="requestmetrics">RequestMetrics<a class="headerlink" href="#requestmetrics" title="Permanent link">#</a></h3>
|
<h3 id="requestmetrics">RequestMetrics<a class="headerlink" href="#requestmetrics" title="Permanent link">#</a></h3>
|
||||||
<p>Ƭ <strong>RequestMetrics</strong>: <code>ReturnType</code><typeof <code>requestMetricsInjectable</code>[<code>"instantiate"</code>]></p>
|
<p>Ƭ <strong>RequestMetrics</strong>: <code>ReturnType</code><typeof <code>requestMetricsInjectable</code>[<code>"instantiate"</code>]></p>
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
Binary file not shown.
Loading…
Reference in New Issue
Block a user