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 committed
1 parent
c2825a795a
commit
18e86df4bc
41 files changed
+13055
-11832
No files matched your search
@@ -832,6 +832,62 @@
|
||||
apiBase
|
||||
</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">
|
||||
@@ -846,6 +902,13 @@
|
||||
namespaced
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#stringifylabels" class="md-nav__link">
|
||||
stringifyLabels
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -1075,69 +1138,6 @@
|
||||
update
|
||||
</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>
|
||||
|
||||
</ul>
|
||||
@@ -1181,8 +1181,17 @@
|
||||
<li><a href="./#spec">spec</a></li>
|
||||
<li><a href="./#status">status</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="./#namespaced">namespaced</a></li>
|
||||
<li><a href="./#stringifylabels">stringifyLabels</a></li>
|
||||
</ul>
|
||||
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
@@ -1218,15 +1227,6 @@
|
||||
<li><a href="./#patch">patch</a></li>
|
||||
<li><a href="./#toplainobject">toPlainObject</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>
|
||||
<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>
|
||||
@@ -1279,301 +1279,13 @@
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||
<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-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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1596,7 +1308,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1611,14 +1323,18 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<hr />
|
||||
<h3 id="isjsonapidata">isJsonApiData<a class="headerlink" href="#isjsonapidata" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isJsonApiData</strong>(<code>object</code>): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<p>▪ <code>Static</code> <strong>isJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown></p>
|
||||
<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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1633,14 +1349,18 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<hr />
|
||||
<h3 id="isjsonapidatalist">isJsonApiDataList<a class="headerlink" href="#isjsonapidatalist" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isJsonApiDataList</strong><<code>T</code>>(<code>object</code>, <code>verifyItem</code>): object is KubeJsonApiDataList<T></p>
|
||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||
<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-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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1653,7 +1373,7 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1672,14 +1392,18 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<hr />
|
||||
<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>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<p>▪ <code>Static</code> <strong>isKubeJsonApiListMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiListMetadata</p>
|
||||
<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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1694,14 +1418,18 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<hr />
|
||||
<h3 id="iskubejsonapimetadata">isKubeJsonApiMetadata<a class="headerlink" href="#iskubejsonapimetadata" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>(<code>object</code>): object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<p>▪ <code>Static</code> <strong>isKubeJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is KubeJsonApiObjectMetadata<KubeObjectScope></p>
|
||||
<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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1716,14 +1444,18 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<hr />
|
||||
<h3 id="isnonsystem">isNonSystem<a class="headerlink" href="#isnonsystem" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isNonSystem</strong>(<code>item</code>): <code>boolean</code></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<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="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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1738,14 +1470,18 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<hr />
|
||||
<h3 id="ispartialjsonapidata">isPartialJsonApiData<a class="headerlink" href="#ispartialjsonapidata" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isPartialJsonApiData</strong>(<code>object</code>): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
|
||||
<p>▪ <code>Static</code> <strong>isPartialJsonApiData</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>></p>
|
||||
<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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1760,14 +1496,18 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<hr />
|
||||
<h3 id="ispartialjsonapimetadata">isPartialJsonApiMetadata<a class="headerlink" href="#ispartialjsonapimetadata" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>(<code>object</code>): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
|
||||
<p>▪ <code>Static</code> <strong>isPartialJsonApiMetadata</strong>: (<code>object</code>: <code>unknown</code>) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>></p>
|
||||
<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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1782,14 +1522,28 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<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>
|
||||
<p>▸ <code>Static</code> <strong>stringifyLabels</strong>(<code>labels?</code>): <code>string</code>[]</p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<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="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>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -1804,10 +1558,287 @@ common race condition.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user